diff --git a/twilio/rest/__init__.py b/twilio/rest/__init__.py index dc7741180b..5838363c52 100644 --- a/twilio/rest/__init__.py +++ b/twilio/rest/__init__.py @@ -29,7 +29,6 @@ from twilio.rest.insights import Insights from twilio.rest.intelligence import Intelligence from twilio.rest.ip_messaging import IpMessaging - from twilio.rest.knowledge import Knowledge from twilio.rest.lookups import Lookups from twilio.rest.marketplace import Marketplace from twilio.rest.messaging import Messaging @@ -143,7 +142,6 @@ def __init__( self._insights: Optional["Insights"] = None self._intelligence: Optional["Intelligence"] = None self._ip_messaging: Optional["IpMessaging"] = None - self._knowledge: Optional["Knowledge"] = None self._lookups: Optional["Lookups"] = None self._marketplace: Optional["Marketplace"] = None self._messaging: Optional["Messaging"] = None @@ -363,19 +361,6 @@ def ip_messaging(self) -> "IpMessaging": self._ip_messaging = IpMessaging(self) return self._ip_messaging - @property - def knowledge(self) -> "Knowledge": - """ - Access the Knowledge Twilio Domain - - :returns: Knowledge Twilio Domain - """ - if self._knowledge is None: - from twilio.rest.knowledge import Knowledge - - self._knowledge = Knowledge(self) - return self._knowledge - @property def lookups(self) -> "Lookups": """ diff --git a/twilio/rest/knowledge/KnowledgeBase.py b/twilio/rest/knowledge/KnowledgeBase.py deleted file mode 100644 index 902f0e8b96..0000000000 --- a/twilio/rest/knowledge/KnowledgeBase.py +++ /dev/null @@ -1,44 +0,0 @@ -r""" - This code was generated by - ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ - | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ - | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ - - NOTE: This class is auto generated by OpenAPI Generator. - https://openapi-generator.tech - Do not edit the class manually. -""" - -from typing import Optional - -from twilio.base.domain import Domain -from twilio.rest import Client -from twilio.rest.knowledge.v1 import V1 - - -class KnowledgeBase(Domain): - - def __init__(self, twilio: Client): - """ - Initialize the Knowledge Domain - - :returns: Domain for Knowledge - """ - super().__init__(twilio, "https://knowledge.twilio.com") - self._v1: Optional[V1] = None - - @property - def v1(self) -> V1: - """ - :returns: Versions v1 of Knowledge - """ - if self._v1 is None: - self._v1 = V1(self) - return self._v1 - - def __repr__(self) -> str: - """ - Provide a friendly representation - :returns: Machine friendly representation - """ - return "" diff --git a/twilio/rest/knowledge/v1/__init__.py b/twilio/rest/knowledge/v1/__init__.py deleted file mode 100644 index 9609bff951..0000000000 --- a/twilio/rest/knowledge/v1/__init__.py +++ /dev/null @@ -1,43 +0,0 @@ -r""" - This code was generated by - ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ - | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ - | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ - - Twilio - Knowledge - This is the public Twilio REST API. - - NOTE: This class is auto generated by OpenAPI Generator. - https://openapi-generator.tech - Do not edit the class manually. -""" - -from typing import Optional -from twilio.base.version import Version -from twilio.base.domain import Domain -from twilio.rest.knowledge.v1.knowledge import KnowledgeList - - -class V1(Version): - - def __init__(self, domain: Domain): - """ - Initialize the V1 version of Knowledge - - :param domain: The Twilio.knowledge domain - """ - super().__init__(domain, "v1") - self._knowledge: Optional[KnowledgeList] = None - - @property - def knowledge(self) -> KnowledgeList: - if self._knowledge is None: - self._knowledge = KnowledgeList(self) - return self._knowledge - - def __repr__(self) -> str: - """ - Provide a friendly representation - :returns: Machine friendly representation - """ - return "" diff --git a/twilio/rest/knowledge/v1/knowledge/__init__.py b/twilio/rest/knowledge/v1/knowledge/__init__.py deleted file mode 100644 index 8ba6b2c481..0000000000 --- a/twilio/rest/knowledge/v1/knowledge/__init__.py +++ /dev/null @@ -1,935 +0,0 @@ -r""" - This code was generated by - ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ - | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ - | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ - - Twilio - Knowledge - This is the public Twilio REST API. - - NOTE: This class is auto generated by OpenAPI Generator. - https://openapi-generator.tech - Do not edit the class manually. -""" - -from datetime import datetime -from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator -from twilio.base import deserialize, values -from twilio.base.instance_context import InstanceContext -from twilio.base.instance_resource import InstanceResource -from twilio.base.list_resource import ListResource -from twilio.base.version import Version -from twilio.base.page import Page -from twilio.rest.knowledge.v1.knowledge.chunk import ChunkList -from twilio.rest.knowledge.v1.knowledge.knowledge_status import KnowledgeStatusList - - -class KnowledgeInstance(InstanceResource): - - class KnowledgeV1ServiceCreateKnowledgeRequest(object): - """ - :ivar description: The description of the knowledge source. - :ivar knowledge_source_details: The details of the knowledge source based on the type. - :ivar name: The name of the tool. - :ivar policy: - :ivar type: The type of the knowledge source. - :ivar embedding_model: The embedding model to be used for the knowledge source. It's required for 'Database' type but disallowed for other types. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.knowledge_source_details: Optional[Dict[str, object]] = payload.get( - "knowledge_source_details" - ) - self.name: Optional[str] = payload.get("name") - self.policy: Optional[ - KnowledgeList.KnowledgeV1ServiceCreatePolicyRequest - ] = payload.get("policy") - self.type: Optional[str] = payload.get("type") - self.embedding_model: Optional[str] = payload.get("embedding_model") - - def to_dict(self): - return { - "description": self.description, - "knowledge_source_details": self.knowledge_source_details, - "name": self.name, - "policy": self.policy.to_dict() if self.policy is not None else None, - "type": self.type, - "embedding_model": self.embedding_model, - } - - class KnowledgeV1ServiceCreatePolicyRequest(object): - """ - :ivar description: The description of the policy. - :ivar id: The Policy ID. - :ivar name: The name of the policy. - :ivar policy_details: - :ivar type: The description of the policy. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.id: Optional[str] = payload.get("id") - self.name: Optional[str] = payload.get("name") - self.policy_details: Optional[Dict[str, object]] = payload.get( - "policy_details" - ) - self.type: Optional[str] = payload.get("type") - - def to_dict(self): - return { - "description": self.description, - "id": self.id, - "name": self.name, - "policy_details": self.policy_details, - "type": self.type, - } - - class KnowledgeV1ServiceUpdateKnowledgeRequest(object): - """ - :ivar description: The description of the knowledge source. - :ivar knowledge_source_details: The details of the knowledge source based on the type. - :ivar name: The name of the knowledge source. - :ivar policy: - :ivar type: The description of the knowledge source. - :ivar embedding_model: The embedding model to be used for the knowledge source. It's only applicable to 'Database' type. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.knowledge_source_details: Optional[Dict[str, object]] = payload.get( - "knowledge_source_details" - ) - self.name: Optional[str] = payload.get("name") - self.policy: Optional[ - KnowledgeList.KnowledgeV1ServiceCreatePolicyRequest - ] = payload.get("policy") - self.type: Optional[str] = payload.get("type") - self.embedding_model: Optional[str] = payload.get("embedding_model") - - def to_dict(self): - return { - "description": self.description, - "knowledge_source_details": self.knowledge_source_details, - "name": self.name, - "policy": self.policy.to_dict() if self.policy is not None else None, - "type": self.type, - "embedding_model": self.embedding_model, - } - - """ - :ivar description: The type of knowledge source. - :ivar id: The description of knowledge. - :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource. - :ivar knowledge_source_details: The details of the knowledge source based on the type. - :ivar name: The name of the knowledge source. - :ivar status: The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED') - :ivar type: The type of knowledge source ('Web', 'Database', 'Text', 'File') - :ivar url: The url of the knowledge resource. - :ivar embedding_model: The embedding model to be used for the knowledge source. - :ivar date_created: The date and time in GMT when the Knowledge was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - :ivar date_updated: The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - """ - - def __init__( - self, version: Version, payload: Dict[str, Any], id: Optional[str] = None - ): - super().__init__(version) - - self.description: Optional[str] = payload.get("description") - self.id: Optional[str] = payload.get("id") - self.account_sid: Optional[str] = payload.get("account_sid") - self.knowledge_source_details: Optional[Dict[str, object]] = payload.get( - "knowledge_source_details" - ) - self.name: Optional[str] = payload.get("name") - self.status: Optional[str] = payload.get("status") - self.type: Optional[str] = payload.get("type") - self.url: Optional[str] = payload.get("url") - self.embedding_model: Optional[str] = payload.get("embedding_model") - self.date_created: Optional[datetime] = deserialize.iso8601_datetime( - payload.get("date_created") - ) - self.date_updated: Optional[datetime] = deserialize.iso8601_datetime( - payload.get("date_updated") - ) - - self._solution = { - "id": id or self.id, - } - self._context: Optional[KnowledgeContext] = None - - @property - def _proxy(self) -> "KnowledgeContext": - """ - Generate an instance context for the instance, the context is capable of - performing various actions. All instance actions are proxied to the context - - :returns: KnowledgeContext for this KnowledgeInstance - """ - if self._context is None: - self._context = KnowledgeContext( - self._version, - id=self._solution["id"], - ) - return self._context - - def delete(self) -> bool: - """ - Deletes the KnowledgeInstance - - - :returns: True if delete succeeds, False otherwise - """ - return self._proxy.delete() - - async def delete_async(self) -> bool: - """ - Asynchronous coroutine that deletes the KnowledgeInstance - - - :returns: True if delete succeeds, False otherwise - """ - return await self._proxy.delete_async() - - def fetch(self) -> "KnowledgeInstance": - """ - Fetch the KnowledgeInstance - - - :returns: The fetched KnowledgeInstance - """ - return self._proxy.fetch() - - async def fetch_async(self) -> "KnowledgeInstance": - """ - Asynchronous coroutine to fetch the KnowledgeInstance - - - :returns: The fetched KnowledgeInstance - """ - return await self._proxy.fetch_async() - - def update( - self, - knowledge_v1_service_update_knowledge_request: Union[ - KnowledgeV1ServiceUpdateKnowledgeRequest, object - ] = values.unset, - ) -> "KnowledgeInstance": - """ - Update the KnowledgeInstance - - :param knowledge_v1_service_update_knowledge_request: - - :returns: The updated KnowledgeInstance - """ - return self._proxy.update( - knowledge_v1_service_update_knowledge_request=knowledge_v1_service_update_knowledge_request, - ) - - async def update_async( - self, - knowledge_v1_service_update_knowledge_request: Union[ - KnowledgeV1ServiceUpdateKnowledgeRequest, object - ] = values.unset, - ) -> "KnowledgeInstance": - """ - Asynchronous coroutine to update the KnowledgeInstance - - :param knowledge_v1_service_update_knowledge_request: - - :returns: The updated KnowledgeInstance - """ - return await self._proxy.update_async( - knowledge_v1_service_update_knowledge_request=knowledge_v1_service_update_knowledge_request, - ) - - @property - def chunks(self) -> ChunkList: - """ - Access the chunks - """ - return self._proxy.chunks - - @property - def knowledge_status(self) -> KnowledgeStatusList: - """ - Access the knowledge_status - """ - return self._proxy.knowledge_status - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - context = " ".join("{}={}".format(k, v) for k, v in self._solution.items()) - return "".format(context) - - -class KnowledgeContext(InstanceContext): - - class KnowledgeV1ServiceCreateKnowledgeRequest(object): - """ - :ivar description: The description of the knowledge source. - :ivar knowledge_source_details: The details of the knowledge source based on the type. - :ivar name: The name of the tool. - :ivar policy: - :ivar type: The type of the knowledge source. - :ivar embedding_model: The embedding model to be used for the knowledge source. It's required for 'Database' type but disallowed for other types. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.knowledge_source_details: Optional[Dict[str, object]] = payload.get( - "knowledge_source_details" - ) - self.name: Optional[str] = payload.get("name") - self.policy: Optional[ - KnowledgeList.KnowledgeV1ServiceCreatePolicyRequest - ] = payload.get("policy") - self.type: Optional[str] = payload.get("type") - self.embedding_model: Optional[str] = payload.get("embedding_model") - - def to_dict(self): - return { - "description": self.description, - "knowledge_source_details": self.knowledge_source_details, - "name": self.name, - "policy": self.policy.to_dict() if self.policy is not None else None, - "type": self.type, - "embedding_model": self.embedding_model, - } - - class KnowledgeV1ServiceCreatePolicyRequest(object): - """ - :ivar description: The description of the policy. - :ivar id: The Policy ID. - :ivar name: The name of the policy. - :ivar policy_details: - :ivar type: The description of the policy. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.id: Optional[str] = payload.get("id") - self.name: Optional[str] = payload.get("name") - self.policy_details: Optional[Dict[str, object]] = payload.get( - "policy_details" - ) - self.type: Optional[str] = payload.get("type") - - def to_dict(self): - return { - "description": self.description, - "id": self.id, - "name": self.name, - "policy_details": self.policy_details, - "type": self.type, - } - - class KnowledgeV1ServiceUpdateKnowledgeRequest(object): - """ - :ivar description: The description of the knowledge source. - :ivar knowledge_source_details: The details of the knowledge source based on the type. - :ivar name: The name of the knowledge source. - :ivar policy: - :ivar type: The description of the knowledge source. - :ivar embedding_model: The embedding model to be used for the knowledge source. It's only applicable to 'Database' type. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.knowledge_source_details: Optional[Dict[str, object]] = payload.get( - "knowledge_source_details" - ) - self.name: Optional[str] = payload.get("name") - self.policy: Optional[ - KnowledgeList.KnowledgeV1ServiceCreatePolicyRequest - ] = payload.get("policy") - self.type: Optional[str] = payload.get("type") - self.embedding_model: Optional[str] = payload.get("embedding_model") - - def to_dict(self): - return { - "description": self.description, - "knowledge_source_details": self.knowledge_source_details, - "name": self.name, - "policy": self.policy.to_dict() if self.policy is not None else None, - "type": self.type, - "embedding_model": self.embedding_model, - } - - def __init__(self, version: Version, id: str): - """ - Initialize the KnowledgeContext - - :param version: Version that contains the resource - :param id: - """ - super().__init__(version) - - # Path Solution - self._solution = { - "id": id, - } - self._uri = "/Knowledge/{id}".format(**self._solution) - - self._chunks: Optional[ChunkList] = None - self._knowledge_status: Optional[KnowledgeStatusList] = None - - def delete(self) -> bool: - """ - Deletes the KnowledgeInstance - - - :returns: True if delete succeeds, False otherwise - """ - - headers = values.of({}) - - return self._version.delete(method="DELETE", uri=self._uri, headers=headers) - - async def delete_async(self) -> bool: - """ - Asynchronous coroutine that deletes the KnowledgeInstance - - - :returns: True if delete succeeds, False otherwise - """ - - headers = values.of({}) - - return await self._version.delete_async( - method="DELETE", uri=self._uri, headers=headers - ) - - def fetch(self) -> KnowledgeInstance: - """ - Fetch the KnowledgeInstance - - - :returns: The fetched KnowledgeInstance - """ - - headers = values.of({}) - - headers["Accept"] = "application/json" - - payload = self._version.fetch(method="GET", uri=self._uri, headers=headers) - - return KnowledgeInstance( - self._version, - payload, - id=self._solution["id"], - ) - - async def fetch_async(self) -> KnowledgeInstance: - """ - Asynchronous coroutine to fetch the KnowledgeInstance - - - :returns: The fetched KnowledgeInstance - """ - - headers = values.of({}) - - headers["Accept"] = "application/json" - - payload = await self._version.fetch_async( - method="GET", uri=self._uri, headers=headers - ) - - return KnowledgeInstance( - self._version, - payload, - id=self._solution["id"], - ) - - def update( - self, - knowledge_v1_service_update_knowledge_request: Union[ - KnowledgeV1ServiceUpdateKnowledgeRequest, object - ] = values.unset, - ) -> KnowledgeInstance: - """ - Update the KnowledgeInstance - - :param knowledge_v1_service_update_knowledge_request: - - :returns: The updated KnowledgeInstance - """ - data = knowledge_v1_service_update_knowledge_request.to_dict() - - headers = values.of({}) - - headers["Content-Type"] = "application/json" - - headers["Accept"] = "application/json" - - payload = self._version.update( - method="PUT", uri=self._uri, data=data, headers=headers - ) - - return KnowledgeInstance(self._version, payload, id=self._solution["id"]) - - async def update_async( - self, - knowledge_v1_service_update_knowledge_request: Union[ - KnowledgeV1ServiceUpdateKnowledgeRequest, object - ] = values.unset, - ) -> KnowledgeInstance: - """ - Asynchronous coroutine to update the KnowledgeInstance - - :param knowledge_v1_service_update_knowledge_request: - - :returns: The updated KnowledgeInstance - """ - data = knowledge_v1_service_update_knowledge_request.to_dict() - - headers = values.of({}) - - headers["Content-Type"] = "application/json" - - headers["Accept"] = "application/json" - - payload = await self._version.update_async( - method="PUT", uri=self._uri, data=data, headers=headers - ) - - return KnowledgeInstance(self._version, payload, id=self._solution["id"]) - - @property - def chunks(self) -> ChunkList: - """ - Access the chunks - """ - if self._chunks is None: - self._chunks = ChunkList( - self._version, - self._solution["id"], - ) - return self._chunks - - @property - def knowledge_status(self) -> KnowledgeStatusList: - """ - Access the knowledge_status - """ - if self._knowledge_status is None: - self._knowledge_status = KnowledgeStatusList( - self._version, - self._solution["id"], - ) - return self._knowledge_status - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - context = " ".join("{}={}".format(k, v) for k, v in self._solution.items()) - return "".format(context) - - -class KnowledgePage(Page): - - def get_instance(self, payload: Dict[str, Any]) -> KnowledgeInstance: - """ - Build an instance of KnowledgeInstance - - :param payload: Payload response from the API - """ - return KnowledgeInstance(self._version, payload) - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - return "" - - -class KnowledgeList(ListResource): - - class KnowledgeV1ServiceCreateKnowledgeRequest(object): - """ - :ivar description: The description of the knowledge source. - :ivar knowledge_source_details: The details of the knowledge source based on the type. - :ivar name: The name of the tool. - :ivar policy: - :ivar type: The type of the knowledge source. - :ivar embedding_model: The embedding model to be used for the knowledge source. It's required for 'Database' type but disallowed for other types. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.knowledge_source_details: Optional[Dict[str, object]] = payload.get( - "knowledge_source_details" - ) - self.name: Optional[str] = payload.get("name") - self.policy: Optional[ - KnowledgeList.KnowledgeV1ServiceCreatePolicyRequest - ] = payload.get("policy") - self.type: Optional[str] = payload.get("type") - self.embedding_model: Optional[str] = payload.get("embedding_model") - - def to_dict(self): - return { - "description": self.description, - "knowledge_source_details": self.knowledge_source_details, - "name": self.name, - "policy": self.policy.to_dict() if self.policy is not None else None, - "type": self.type, - "embedding_model": self.embedding_model, - } - - class KnowledgeV1ServiceCreatePolicyRequest(object): - """ - :ivar description: The description of the policy. - :ivar id: The Policy ID. - :ivar name: The name of the policy. - :ivar policy_details: - :ivar type: The description of the policy. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.id: Optional[str] = payload.get("id") - self.name: Optional[str] = payload.get("name") - self.policy_details: Optional[Dict[str, object]] = payload.get( - "policy_details" - ) - self.type: Optional[str] = payload.get("type") - - def to_dict(self): - return { - "description": self.description, - "id": self.id, - "name": self.name, - "policy_details": self.policy_details, - "type": self.type, - } - - class KnowledgeV1ServiceUpdateKnowledgeRequest(object): - """ - :ivar description: The description of the knowledge source. - :ivar knowledge_source_details: The details of the knowledge source based on the type. - :ivar name: The name of the knowledge source. - :ivar policy: - :ivar type: The description of the knowledge source. - :ivar embedding_model: The embedding model to be used for the knowledge source. It's only applicable to 'Database' type. - """ - - def __init__(self, payload: Dict[str, Any]): - - self.description: Optional[str] = payload.get("description") - self.knowledge_source_details: Optional[Dict[str, object]] = payload.get( - "knowledge_source_details" - ) - self.name: Optional[str] = payload.get("name") - self.policy: Optional[ - KnowledgeList.KnowledgeV1ServiceCreatePolicyRequest - ] = payload.get("policy") - self.type: Optional[str] = payload.get("type") - self.embedding_model: Optional[str] = payload.get("embedding_model") - - def to_dict(self): - return { - "description": self.description, - "knowledge_source_details": self.knowledge_source_details, - "name": self.name, - "policy": self.policy.to_dict() if self.policy is not None else None, - "type": self.type, - "embedding_model": self.embedding_model, - } - - def __init__(self, version: Version): - """ - Initialize the KnowledgeList - - :param version: Version that contains the resource - - """ - super().__init__(version) - - self._uri = "/Knowledge" - - def create( - self, - knowledge_v1_service_create_knowledge_request: KnowledgeV1ServiceCreateKnowledgeRequest, - ) -> KnowledgeInstance: - """ - Create the KnowledgeInstance - - :param knowledge_v1_service_create_knowledge_request: - - :returns: The created KnowledgeInstance - """ - data = knowledge_v1_service_create_knowledge_request.to_dict() - - headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) - - headers["Content-Type"] = "application/json" - - headers["Accept"] = "application/json" - - payload = self._version.create( - method="POST", uri=self._uri, data=data, headers=headers - ) - - return KnowledgeInstance(self._version, payload) - - async def create_async( - self, - knowledge_v1_service_create_knowledge_request: KnowledgeV1ServiceCreateKnowledgeRequest, - ) -> KnowledgeInstance: - """ - Asynchronously create the KnowledgeInstance - - :param knowledge_v1_service_create_knowledge_request: - - :returns: The created KnowledgeInstance - """ - data = knowledge_v1_service_create_knowledge_request.to_dict() - - headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) - - headers["Content-Type"] = "application/json" - - headers["Accept"] = "application/json" - - payload = await self._version.create_async( - method="POST", uri=self._uri, data=data, headers=headers - ) - - return KnowledgeInstance(self._version, payload) - - def stream( - self, - limit: Optional[int] = None, - page_size: Optional[int] = None, - ) -> Iterator[KnowledgeInstance]: - """ - Streams KnowledgeInstance records from the API as a generator stream. - This operation lazily loads records as efficiently as possible until the limit - is reached. - The results are returned as a generator, so this operation is memory efficient. - - :param limit: Upper limit for the number of records to return. stream() - guarantees to never return more than limit. Default is no limit - :param page_size: Number of records to fetch per request, when not set will use - the default value of 50 records. If no page_size is defined - but a limit is defined, stream() will attempt to read the - limit with the most efficient page size, i.e. min(limit, 1000) - - :returns: Generator that will yield up to limit results - """ - limits = self._version.read_limits(limit, page_size) - page = self.page(page_size=limits["page_size"]) - - return self._version.stream(page, limits["limit"]) - - async def stream_async( - self, - limit: Optional[int] = None, - page_size: Optional[int] = None, - ) -> AsyncIterator[KnowledgeInstance]: - """ - Asynchronously streams KnowledgeInstance records from the API as a generator stream. - This operation lazily loads records as efficiently as possible until the limit - is reached. - The results are returned as a generator, so this operation is memory efficient. - - :param limit: Upper limit for the number of records to return. stream() - guarantees to never return more than limit. Default is no limit - :param page_size: Number of records to fetch per request, when not set will use - the default value of 50 records. If no page_size is defined - but a limit is defined, stream() will attempt to read the - limit with the most efficient page size, i.e. min(limit, 1000) - - :returns: Generator that will yield up to limit results - """ - limits = self._version.read_limits(limit, page_size) - page = await self.page_async(page_size=limits["page_size"]) - - return self._version.stream_async(page, limits["limit"]) - - def list( - self, - limit: Optional[int] = None, - page_size: Optional[int] = None, - ) -> List[KnowledgeInstance]: - """ - Lists KnowledgeInstance records from the API as a list. - Unlike stream(), this operation is eager and will load `limit` records into - memory before returning. - - :param limit: Upper limit for the number of records to return. list() guarantees - never to return more than limit. Default is no limit - :param page_size: Number of records to fetch per request, when not set will use - the default value of 50 records. If no page_size is defined - but a limit is defined, list() will attempt to read the limit - with the most efficient page size, i.e. min(limit, 1000) - - :returns: list that will contain up to limit results - """ - return list( - self.stream( - limit=limit, - page_size=page_size, - ) - ) - - async def list_async( - self, - limit: Optional[int] = None, - page_size: Optional[int] = None, - ) -> List[KnowledgeInstance]: - """ - Asynchronously lists KnowledgeInstance records from the API as a list. - Unlike stream(), this operation is eager and will load `limit` records into - memory before returning. - - :param limit: Upper limit for the number of records to return. list() guarantees - never to return more than limit. Default is no limit - :param page_size: Number of records to fetch per request, when not set will use - the default value of 50 records. If no page_size is defined - but a limit is defined, list() will attempt to read the limit - with the most efficient page size, i.e. min(limit, 1000) - - :returns: list that will contain up to limit results - """ - return [ - record - async for record in await self.stream_async( - limit=limit, - page_size=page_size, - ) - ] - - def page( - self, - page_token: Union[str, object] = values.unset, - page_number: Union[int, object] = values.unset, - page_size: Union[int, object] = values.unset, - ) -> KnowledgePage: - """ - Retrieve a single page of KnowledgeInstance records from the API. - Request is executed immediately - - :param page_token: PageToken provided by the API - :param page_number: Page Number, this value is simply for client state - :param page_size: Number of records to return, defaults to 50 - - :returns: Page of KnowledgeInstance - """ - data = values.of( - { - "PageToken": page_token, - "Page": page_number, - "PageSize": page_size, - } - ) - - headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) - - headers["Accept"] = "application/json" - - response = self._version.page( - method="GET", uri=self._uri, params=data, headers=headers - ) - return KnowledgePage(self._version, response) - - async def page_async( - self, - page_token: Union[str, object] = values.unset, - page_number: Union[int, object] = values.unset, - page_size: Union[int, object] = values.unset, - ) -> KnowledgePage: - """ - Asynchronously retrieve a single page of KnowledgeInstance records from the API. - Request is executed immediately - - :param page_token: PageToken provided by the API - :param page_number: Page Number, this value is simply for client state - :param page_size: Number of records to return, defaults to 50 - - :returns: Page of KnowledgeInstance - """ - data = values.of( - { - "PageToken": page_token, - "Page": page_number, - "PageSize": page_size, - } - ) - - headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) - - headers["Accept"] = "application/json" - - response = await self._version.page_async( - method="GET", uri=self._uri, params=data, headers=headers - ) - return KnowledgePage(self._version, response) - - def get_page(self, target_url: str) -> KnowledgePage: - """ - Retrieve a specific page of KnowledgeInstance records from the API. - Request is executed immediately - - :param target_url: API-generated URL for the requested results page - - :returns: Page of KnowledgeInstance - """ - response = self._version.domain.twilio.request("GET", target_url) - return KnowledgePage(self._version, response) - - async def get_page_async(self, target_url: str) -> KnowledgePage: - """ - Asynchronously retrieve a specific page of KnowledgeInstance records from the API. - Request is executed immediately - - :param target_url: API-generated URL for the requested results page - - :returns: Page of KnowledgeInstance - """ - response = await self._version.domain.twilio.request_async("GET", target_url) - return KnowledgePage(self._version, response) - - def get(self, id: str) -> KnowledgeContext: - """ - Constructs a KnowledgeContext - - :param id: - """ - return KnowledgeContext(self._version, id=id) - - def __call__(self, id: str) -> KnowledgeContext: - """ - Constructs a KnowledgeContext - - :param id: - """ - return KnowledgeContext(self._version, id=id) - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - return "" diff --git a/twilio/rest/knowledge/v1/knowledge/chunk.py b/twilio/rest/knowledge/v1/knowledge/chunk.py deleted file mode 100644 index 55c0b1be1a..0000000000 --- a/twilio/rest/knowledge/v1/knowledge/chunk.py +++ /dev/null @@ -1,297 +0,0 @@ -r""" - This code was generated by - ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ - | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ - | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ - - Twilio - Knowledge - This is the public Twilio REST API. - - NOTE: This class is auto generated by OpenAPI Generator. - https://openapi-generator.tech - Do not edit the class manually. -""" - -from datetime import datetime -from typing import Any, Dict, List, Optional, Union, Iterator, AsyncIterator -from twilio.base import deserialize, values - -from twilio.base.instance_resource import InstanceResource -from twilio.base.list_resource import ListResource -from twilio.base.version import Version -from twilio.base.page import Page - - -class ChunkInstance(InstanceResource): - """ - :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource. - :ivar content: The chunk content. - :ivar metadata: The metadata of the chunk. - :ivar date_created: The date and time in GMT when the Chunk was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - :ivar date_updated: The date and time in GMT when the Chunk was updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - """ - - def __init__(self, version: Version, payload: Dict[str, Any], id: str): - super().__init__(version) - - self.account_sid: Optional[str] = payload.get("account_sid") - self.content: Optional[str] = payload.get("content") - self.metadata: Optional[Dict[str, object]] = payload.get("metadata") - self.date_created: Optional[datetime] = deserialize.iso8601_datetime( - payload.get("date_created") - ) - self.date_updated: Optional[datetime] = deserialize.iso8601_datetime( - payload.get("date_updated") - ) - - self._solution = { - "id": id, - } - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - context = " ".join("{}={}".format(k, v) for k, v in self._solution.items()) - return "".format(context) - - -class ChunkPage(Page): - - def get_instance(self, payload: Dict[str, Any]) -> ChunkInstance: - """ - Build an instance of ChunkInstance - - :param payload: Payload response from the API - """ - return ChunkInstance(self._version, payload, id=self._solution["id"]) - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - return "" - - -class ChunkList(ListResource): - - def __init__(self, version: Version, id: str): - """ - Initialize the ChunkList - - :param version: Version that contains the resource - :param id: The knowledge ID. - - """ - super().__init__(version) - - # Path Solution - self._solution = { - "id": id, - } - self._uri = "/Knowledge/{id}/Chunks".format(**self._solution) - - def stream( - self, - limit: Optional[int] = None, - page_size: Optional[int] = None, - ) -> Iterator[ChunkInstance]: - """ - Streams ChunkInstance records from the API as a generator stream. - This operation lazily loads records as efficiently as possible until the limit - is reached. - The results are returned as a generator, so this operation is memory efficient. - - :param limit: Upper limit for the number of records to return. stream() - guarantees to never return more than limit. Default is no limit - :param page_size: Number of records to fetch per request, when not set will use - the default value of 50 records. If no page_size is defined - but a limit is defined, stream() will attempt to read the - limit with the most efficient page size, i.e. min(limit, 1000) - - :returns: Generator that will yield up to limit results - """ - limits = self._version.read_limits(limit, page_size) - page = self.page(page_size=limits["page_size"]) - - return self._version.stream(page, limits["limit"]) - - async def stream_async( - self, - limit: Optional[int] = None, - page_size: Optional[int] = None, - ) -> AsyncIterator[ChunkInstance]: - """ - Asynchronously streams ChunkInstance records from the API as a generator stream. - This operation lazily loads records as efficiently as possible until the limit - is reached. - The results are returned as a generator, so this operation is memory efficient. - - :param limit: Upper limit for the number of records to return. stream() - guarantees to never return more than limit. Default is no limit - :param page_size: Number of records to fetch per request, when not set will use - the default value of 50 records. If no page_size is defined - but a limit is defined, stream() will attempt to read the - limit with the most efficient page size, i.e. min(limit, 1000) - - :returns: Generator that will yield up to limit results - """ - limits = self._version.read_limits(limit, page_size) - page = await self.page_async(page_size=limits["page_size"]) - - return self._version.stream_async(page, limits["limit"]) - - def list( - self, - limit: Optional[int] = None, - page_size: Optional[int] = None, - ) -> List[ChunkInstance]: - """ - Lists ChunkInstance records from the API as a list. - Unlike stream(), this operation is eager and will load `limit` records into - memory before returning. - - :param limit: Upper limit for the number of records to return. list() guarantees - never to return more than limit. Default is no limit - :param page_size: Number of records to fetch per request, when not set will use - the default value of 50 records. If no page_size is defined - but a limit is defined, list() will attempt to read the limit - with the most efficient page size, i.e. min(limit, 1000) - - :returns: list that will contain up to limit results - """ - return list( - self.stream( - limit=limit, - page_size=page_size, - ) - ) - - async def list_async( - self, - limit: Optional[int] = None, - page_size: Optional[int] = None, - ) -> List[ChunkInstance]: - """ - Asynchronously lists ChunkInstance records from the API as a list. - Unlike stream(), this operation is eager and will load `limit` records into - memory before returning. - - :param limit: Upper limit for the number of records to return. list() guarantees - never to return more than limit. Default is no limit - :param page_size: Number of records to fetch per request, when not set will use - the default value of 50 records. If no page_size is defined - but a limit is defined, list() will attempt to read the limit - with the most efficient page size, i.e. min(limit, 1000) - - :returns: list that will contain up to limit results - """ - return [ - record - async for record in await self.stream_async( - limit=limit, - page_size=page_size, - ) - ] - - def page( - self, - page_token: Union[str, object] = values.unset, - page_number: Union[int, object] = values.unset, - page_size: Union[int, object] = values.unset, - ) -> ChunkPage: - """ - Retrieve a single page of ChunkInstance records from the API. - Request is executed immediately - - :param page_token: PageToken provided by the API - :param page_number: Page Number, this value is simply for client state - :param page_size: Number of records to return, defaults to 50 - - :returns: Page of ChunkInstance - """ - data = values.of( - { - "PageToken": page_token, - "Page": page_number, - "PageSize": page_size, - } - ) - - headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) - - headers["Accept"] = "application/json" - - response = self._version.page( - method="GET", uri=self._uri, params=data, headers=headers - ) - return ChunkPage(self._version, response, self._solution) - - async def page_async( - self, - page_token: Union[str, object] = values.unset, - page_number: Union[int, object] = values.unset, - page_size: Union[int, object] = values.unset, - ) -> ChunkPage: - """ - Asynchronously retrieve a single page of ChunkInstance records from the API. - Request is executed immediately - - :param page_token: PageToken provided by the API - :param page_number: Page Number, this value is simply for client state - :param page_size: Number of records to return, defaults to 50 - - :returns: Page of ChunkInstance - """ - data = values.of( - { - "PageToken": page_token, - "Page": page_number, - "PageSize": page_size, - } - ) - - headers = values.of({"Content-Type": "application/x-www-form-urlencoded"}) - - headers["Accept"] = "application/json" - - response = await self._version.page_async( - method="GET", uri=self._uri, params=data, headers=headers - ) - return ChunkPage(self._version, response, self._solution) - - def get_page(self, target_url: str) -> ChunkPage: - """ - Retrieve a specific page of ChunkInstance records from the API. - Request is executed immediately - - :param target_url: API-generated URL for the requested results page - - :returns: Page of ChunkInstance - """ - response = self._version.domain.twilio.request("GET", target_url) - return ChunkPage(self._version, response, self._solution) - - async def get_page_async(self, target_url: str) -> ChunkPage: - """ - Asynchronously retrieve a specific page of ChunkInstance records from the API. - Request is executed immediately - - :param target_url: API-generated URL for the requested results page - - :returns: Page of ChunkInstance - """ - response = await self._version.domain.twilio.request_async("GET", target_url) - return ChunkPage(self._version, response, self._solution) - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - return "" diff --git a/twilio/rest/knowledge/v1/knowledge/knowledge_status.py b/twilio/rest/knowledge/v1/knowledge/knowledge_status.py deleted file mode 100644 index 984c577aac..0000000000 --- a/twilio/rest/knowledge/v1/knowledge/knowledge_status.py +++ /dev/null @@ -1,196 +0,0 @@ -r""" - This code was generated by - ___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __ - | | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/ - | |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \ - - Twilio - Knowledge - This is the public Twilio REST API. - - NOTE: This class is auto generated by OpenAPI Generator. - https://openapi-generator.tech - Do not edit the class manually. -""" - -from datetime import datetime -from typing import Any, Dict, Optional -from twilio.base import deserialize, values -from twilio.base.instance_context import InstanceContext -from twilio.base.instance_resource import InstanceResource -from twilio.base.list_resource import ListResource -from twilio.base.version import Version - - -class KnowledgeStatusInstance(InstanceResource): - """ - :ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Knowledge resource. - :ivar status: The status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED') - :ivar last_status: The last status of processing the knowledge source ('QUEUED', 'PROCESSING', 'COMPLETED', 'FAILED') - :ivar date_updated: The date and time in GMT when the Knowledge was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - """ - - def __init__(self, version: Version, payload: Dict[str, Any], id: str): - super().__init__(version) - - self.account_sid: Optional[str] = payload.get("account_sid") - self.status: Optional[str] = payload.get("status") - self.last_status: Optional[str] = payload.get("last_status") - self.date_updated: Optional[datetime] = deserialize.iso8601_datetime( - payload.get("date_updated") - ) - - self._solution = { - "id": id, - } - self._context: Optional[KnowledgeStatusContext] = None - - @property - def _proxy(self) -> "KnowledgeStatusContext": - """ - Generate an instance context for the instance, the context is capable of - performing various actions. All instance actions are proxied to the context - - :returns: KnowledgeStatusContext for this KnowledgeStatusInstance - """ - if self._context is None: - self._context = KnowledgeStatusContext( - self._version, - id=self._solution["id"], - ) - return self._context - - def fetch(self) -> "KnowledgeStatusInstance": - """ - Fetch the KnowledgeStatusInstance - - - :returns: The fetched KnowledgeStatusInstance - """ - return self._proxy.fetch() - - async def fetch_async(self) -> "KnowledgeStatusInstance": - """ - Asynchronous coroutine to fetch the KnowledgeStatusInstance - - - :returns: The fetched KnowledgeStatusInstance - """ - return await self._proxy.fetch_async() - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - context = " ".join("{}={}".format(k, v) for k, v in self._solution.items()) - return "".format(context) - - -class KnowledgeStatusContext(InstanceContext): - - def __init__(self, version: Version, id: str): - """ - Initialize the KnowledgeStatusContext - - :param version: Version that contains the resource - :param id: the Knowledge ID. - """ - super().__init__(version) - - # Path Solution - self._solution = { - "id": id, - } - self._uri = "/Knowledge/{id}/Status".format(**self._solution) - - def fetch(self) -> KnowledgeStatusInstance: - """ - Fetch the KnowledgeStatusInstance - - - :returns: The fetched KnowledgeStatusInstance - """ - - headers = values.of({}) - - headers["Accept"] = "application/json" - - payload = self._version.fetch(method="GET", uri=self._uri, headers=headers) - - return KnowledgeStatusInstance( - self._version, - payload, - id=self._solution["id"], - ) - - async def fetch_async(self) -> KnowledgeStatusInstance: - """ - Asynchronous coroutine to fetch the KnowledgeStatusInstance - - - :returns: The fetched KnowledgeStatusInstance - """ - - headers = values.of({}) - - headers["Accept"] = "application/json" - - payload = await self._version.fetch_async( - method="GET", uri=self._uri, headers=headers - ) - - return KnowledgeStatusInstance( - self._version, - payload, - id=self._solution["id"], - ) - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - context = " ".join("{}={}".format(k, v) for k, v in self._solution.items()) - return "".format(context) - - -class KnowledgeStatusList(ListResource): - - def __init__(self, version: Version, id: str): - """ - Initialize the KnowledgeStatusList - - :param version: Version that contains the resource - :param id: the Knowledge ID. - - """ - super().__init__(version) - - # Path Solution - self._solution = { - "id": id, - } - - def get(self) -> KnowledgeStatusContext: - """ - Constructs a KnowledgeStatusContext - - """ - return KnowledgeStatusContext(self._version, id=self._solution["id"]) - - def __call__(self) -> KnowledgeStatusContext: - """ - Constructs a KnowledgeStatusContext - - """ - return KnowledgeStatusContext(self._version, id=self._solution["id"]) - - def __repr__(self) -> str: - """ - Provide a friendly representation - - :returns: Machine friendly representation - """ - return ""