egain-api-python 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,10 +3,10 @@
3
3
  import importlib.metadata
4
4
 
5
5
  __title__: str = "egain-api-python"
6
- __version__: str = "0.1.6"
6
+ __version__: str = "0.1.7"
7
7
  __openapi_doc_version__: str = "4.0.0"
8
- __gen_version__: str = "2.723.8"
9
- __user_agent__: str = "speakeasy-sdk/python 0.1.6 2.723.8 4.0.0 egain-api-python"
8
+ __gen_version__: str = "2.723.11"
9
+ __user_agent__: str = "speakeasy-sdk/python 0.1.7 2.723.11 4.0.0 egain-api-python"
10
10
 
11
11
  try:
12
12
  if __package__ is not None:
@@ -9,7 +9,7 @@ from egain_api_python.errors import EgainError
9
9
  MAX_MESSAGE_LEN = 10_000
10
10
 
11
11
 
12
- @dataclass(frozen=True)
12
+ @dataclass(unsafe_hash=True)
13
13
  class EgainDefaultError(EgainError):
14
14
  """The fallback error class if no more specific error class is matched."""
15
15
 
@@ -5,7 +5,7 @@ from typing import Optional
5
5
  from dataclasses import dataclass, field
6
6
 
7
7
 
8
- @dataclass(frozen=True)
8
+ @dataclass(unsafe_hash=True)
9
9
  class EgainError(Exception):
10
10
  """The base class for all HTTP error responses."""
11
11
 
@@ -58,7 +58,7 @@ class ServiceUnavailableErrorData(BaseModel):
58
58
  """
59
59
 
60
60
 
61
- @dataclass(frozen=True)
61
+ @dataclass(unsafe_hash=True)
62
62
  class ServiceUnavailableError(EgainError):
63
63
  r"""## Service is Unhealthy
64
64
 
@@ -3,7 +3,7 @@
3
3
  from dataclasses import dataclass
4
4
 
5
5
 
6
- @dataclass(frozen=True)
6
+ @dataclass(unsafe_hash=True)
7
7
  class NoResponseError(Exception):
8
8
  """Error raised when no HTTP response is received from the server."""
9
9
 
@@ -7,7 +7,7 @@ from dataclasses import dataclass
7
7
  from egain_api_python.errors import EgainError
8
8
 
9
9
 
10
- @dataclass(frozen=True)
10
+ @dataclass(unsafe_hash=True)
11
11
  class ResponseValidationError(EgainError):
12
12
  """Error raised when there is a type mismatch between the response data and the expected Pydantic model."""
13
13
 
@@ -34,7 +34,7 @@ class SchemasWSErrorCommonData(BaseModel):
34
34
  """
35
35
 
36
36
 
37
- @dataclass(frozen=True)
37
+ @dataclass(unsafe_hash=True)
38
38
  class SchemasWSErrorCommon(EgainError):
39
39
  r"""Preconditions failed"""
40
40
 
@@ -32,7 +32,7 @@ class WSErrorCommonData(BaseModel):
32
32
  """
33
33
 
34
34
 
35
- @dataclass(frozen=True)
35
+ @dataclass(unsafe_hash=True)
36
36
  class WSErrorCommon(EgainError):
37
37
  r"""Bad Request"""
38
38
 
@@ -17,7 +17,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
17
17
 
18
18
  GET_BEST_ANSWER_OP_SERVERS = [
19
19
  # aiservices
20
- "https://api.aidev.egain.cloud/core/aiservices/v4",
20
+ "https://${API_DOMAIN}/core/aiservices/v4",
21
21
  ]
22
22
 
23
23
 
@@ -4,7 +4,7 @@ from __future__ import annotations
4
4
  from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
5
5
  from egain_api_python.types import BaseModel
6
6
  import pydantic
7
- from typing import Literal, Optional
7
+ from typing import List, Literal, Optional
8
8
  from typing_extensions import Annotated, NotRequired, TypedDict
9
9
 
10
10
 
@@ -36,8 +36,7 @@ class ReferenceResponseTypedDict(TypedDict):
36
36
  r"""Source Type"""
37
37
  doc_name: NotRequired[str]
38
38
  r"""Name of the attachment, if an attachment was used as the source content."""
39
- topic_breadcrumb: NotRequired[TopicBreadcrumbTypedDict]
40
- r"""This schema contains one or more TopicSummary instances."""
39
+ topic_breadcrumb: NotRequired[List[TopicBreadcrumbTypedDict]]
41
40
 
42
41
 
43
42
  class ReferenceResponse(BaseModel):
@@ -59,6 +58,5 @@ class ReferenceResponse(BaseModel):
59
58
  r"""Name of the attachment, if an attachment was used as the source content."""
60
59
 
61
60
  topic_breadcrumb: Annotated[
62
- Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadcrumb")
61
+ Optional[List[TopicBreadcrumb]], pydantic.Field(alias="topicBreadcrumb")
63
62
  ] = None
64
- r"""This schema contains one or more TopicSummary instances."""
@@ -17,7 +17,7 @@ from typing_extensions import Annotated, NotRequired, TypedDict
17
17
 
18
18
  RETRIEVE_CHUNKS_OP_SERVERS = [
19
19
  # aiservices
20
- "https://api.aidev.egain.cloud/core/aiservices/v4",
20
+ "https://${API_DOMAIN}/core/aiservices/v4",
21
21
  ]
22
22
 
23
23
 
@@ -4,7 +4,7 @@ from __future__ import annotations
4
4
  from .topicbreadcrumb import TopicBreadcrumb, TopicBreadcrumbTypedDict
5
5
  from egain_api_python.types import BaseModel
6
6
  import pydantic
7
- from typing import Literal, Optional
7
+ from typing import List, Literal, Optional
8
8
  from typing_extensions import Annotated, NotRequired, TypedDict
9
9
 
10
10
 
@@ -47,8 +47,7 @@ class SearchResultTypedDict(TypedDict):
47
47
  doc_name: NotRequired[str]
48
48
  r"""Name of the attachment, if an attachment was used as the source content."""
49
49
  snippet_type: NotRequired[SnippetType]
50
- topic_breadcrumb: NotRequired[TopicBreadcrumbTypedDict]
51
- r"""This schema contains one or more TopicSummary instances."""
50
+ topic_breadcrumb: NotRequired[List[TopicBreadcrumbTypedDict]]
52
51
 
53
52
 
54
53
  class SearchResult(BaseModel):
@@ -80,6 +79,5 @@ class SearchResult(BaseModel):
80
79
  ] = None
81
80
 
82
81
  topic_breadcrumb: Annotated[
83
- Optional[TopicBreadcrumb], pydantic.Field(alias="topicBreadcrumb")
82
+ Optional[List[TopicBreadcrumb]], pydantic.Field(alias="topicBreadcrumb")
84
83
  ] = None
85
- r"""This schema contains one or more TopicSummary instances."""
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: egain-api-python
3
- Version: 0.1.6
3
+ Version: 0.1.7
4
4
  Summary: Python Client SDK Generated by Speakeasy.
5
5
  Author: Speakeasy
6
6
  Requires-Python: >=3.9.2
@@ -642,7 +642,7 @@ with Egain(
642
642
  ],
643
643
  }, channel={
644
644
  "name": "Eight Bank Website",
645
- }, server_url="https://api.aidev.egain.cloud/core/aiservices/v4")
645
+ }, server_url="https://${API_DOMAIN}/core/aiservices/v4")
646
646
 
647
647
  # Handle response
648
648
  print(res)
@@ -1,5 +1,5 @@
1
1
  egain_api_python/__init__.py,sha256=w2u919V3Tzv4zEPQ-OYJ79gQ_4_SyW7GOFFoHtqXDFA,401
2
- egain_api_python/_version.py,sha256=zAkqg0Tfih-_65oF12ZHWFRktseWO-9nNyoYfTUkzF8,474
2
+ egain_api_python/_version.py,sha256=KbVCb8lEgss1ks7Kati0SMbPwM-1UUwVwhPASSLZVM0,476
3
3
  egain_api_python/aiservices.py,sha256=vFG7gOYnOknIMJvxgzD2dUFFqtlsD2WZoLrrb-YpbKM,787
4
4
  egain_api_python/answers.py,sha256=SjgG4GQNR3cZLXae0CXEp23FgKun0XrLFO-ZYl0wtAc,12769
5
5
  egain_api_python/articlelists.py,sha256=j29Fvkfjuq9OZbmMnlZm1WPkdz2eu2zkdvxd8JULzz8,23630
@@ -34,13 +34,13 @@ egain_api_python/_hooks/registration.py,sha256=1QZB41w6If7I9dXiOSQx6dhSc6BPWrnI5
34
34
  egain_api_python/_hooks/sdkhooks.py,sha256=7UhuXJWFnCxMTIORvzEmSUXhrxeEX_Xegsh4-NPhxVE,2533
35
35
  egain_api_python/_hooks/types.py,sha256=cNaI6SrmEi7lq8Whft1SSPE6b6sCqD4msMSHCx85hPo,2995
36
36
  egain_api_python/errors/__init__.py,sha256=JLEpVh1ACVJ8AtbfJot_DO6Qx3z0GlDnzXS_Sg8vK-E,2575
37
- egain_api_python/errors/egaindefaulterror.py,sha256=jXs35rHSipG-9WLLmaLaJ_YghdH1qttfhrPWs10MRns,1293
38
- egain_api_python/errors/egainerror.py,sha256=S_BIFBTaMEjG5KOhmmyjoEfRTDRfVMSaga694K6mFyI,949
39
- egain_api_python/errors/gethealthop.py,sha256=LUrUR9GYuppBmxwyfmU2ljRNd_r2Om924MP8laTuNJk,2616
40
- egain_api_python/errors/no_response_error.py,sha256=Kb7hmMtDo72KrLSjUEDNeQxvzZiVxUjOZym8TPdZp5Y,462
41
- egain_api_python/errors/responsevalidationerror.py,sha256=KpSSNBZAuiOCDeClbrbrxcTze8-jaaNigDXaSem1nqo,751
42
- egain_api_python/errors/schemas_wserrorcommon.py,sha256=CMSpNcBSx97MLLNpw1Dx_sVz4GF38ocNOoINkYFrGYk,1610
43
- egain_api_python/errors/wserrorcommon.py,sha256=Eo_Zv01PvBgw5U8DmCeZRc-0wQIZLtg8MCWX3vazeYI,1603
37
+ egain_api_python/errors/egaindefaulterror.py,sha256=kq5xDKH5Lf5BD1BvVcA0EJPE62FvHgNyYr2Dfspf3JI,1298
38
+ egain_api_python/errors/egainerror.py,sha256=hV9jhJU2MhETp5ZdcUf3rDEzY-rWzh8r1SDYqjPIkwg,954
39
+ egain_api_python/errors/gethealthop.py,sha256=HZt588pTVzzMouO18pQxqDMGkBc0BrE7Rbhc8YoA4So,2621
40
+ egain_api_python/errors/no_response_error.py,sha256=DaZukP5ManflzAN-11MtmBitfTIct37sRvfszvfM13o,467
41
+ egain_api_python/errors/responsevalidationerror.py,sha256=0aS03VFCXKp7-O50jE7s4EKbLdegaOFhCtE_xKdEtt8,756
42
+ egain_api_python/errors/schemas_wserrorcommon.py,sha256=2DAJrtoTE_b-97IixCzmUm2i0FiAfes4WCitIbIJmLI,1615
43
+ egain_api_python/errors/wserrorcommon.py,sha256=CXuAhzFJnlE7mM5_Zp7lYVvPvofDiaYVMXZDUscuRQE,1608
44
44
  egain_api_python/models/__init__.py,sha256=nrV5tw7xrn0KBybWvCjcYiYYnluHO68q5SuTcwS0hEg,85611
45
45
  egain_api_python/models/acceptghsolutionop.py,sha256=9tDUzQcJ-8wQxn80rtlRQD3xEUaIZvgmN7lzTkYkaAQ,2040
46
46
  egain_api_python/models/acceptlanguage.py,sha256=Xd_j9CzzaDUGpeObslxSSS0SGvKJjWkYLgk1jH7lu74,360
@@ -174,7 +174,7 @@ egain_api_python/models/getarticlepersonalizationop.py,sha256=mNirdQnZoFVZpxpmaW
174
174
  egain_api_python/models/getarticleratingsop.py,sha256=O6rF8pKPFK08ToL3Ib3Qx4zzw4huHRFw0kBhAN7T4Ds,3587
175
175
  egain_api_python/models/getarticlesintopicop.py,sha256=u3fcw9Y8LLkUulVzJPWL-jhMP4k6ND7OfpFEEaCw4Cs,8949
176
176
  egain_api_python/models/getattachmentbyidinportalop.py,sha256=OUzIdSanWoDzNGwdGPcjRSKlOvTccE4zZGJfce-xxEk,2728
177
- egain_api_python/models/getbestanswerop.py,sha256=2qA0hk473drr6ndO6s_FLNIETG0P0tVGnFYr5guhNsI,3635
177
+ egain_api_python/models/getbestanswerop.py,sha256=TDDTRYVjc5y7mGxPVHq4qCrZ8gNhqUcIw01-HK1nW98,3627
178
178
  egain_api_python/models/getbookmarkop.py,sha256=GBAVyKHZqqJDgazWDhhsmZ71JQX-leW9mqRpXv7KpKE,1399
179
179
  egain_api_python/models/getcasebasereleasebyidop.py,sha256=CT3ukkOsJF_TZkr6qbtTxotzGMXnEbmezuRAAUYottY,2923
180
180
  egain_api_python/models/getcasebyidop.py,sha256=_FqZFbM1lke2943ovzJ62aTUZ8d2PJknFKRoOqYrGb8,3452
@@ -240,11 +240,11 @@ egain_api_python/models/quickpickrating.py,sha256=OwZU3xsJzPYLAtcJJuvHMkZCO8NQF0
240
240
  egain_api_python/models/quickpickresult.py,sha256=YH0Ml5gq3yJvWOoDBFAW1XNPEomyHJXTuPLkv40tb-I,1037
241
241
  egain_api_python/models/quickpickresults.py,sha256=kUHHWZjFgmwsNEox9ehGsgU5wcapm3qD4uz0kAlWeio,865
242
242
  egain_api_python/models/ratearticleop.py,sha256=QQiRo2K35ctT4kjBS3ri6ImepxhIVagCanaREYP1zWg,3224
243
- egain_api_python/models/referenceresponse.py,sha256=G06WC9VVURzgw9QVS15E7r0B7ykjtB4ZMiPu_U-TGt8,2147
243
+ egain_api_python/models/referenceresponse.py,sha256=uVtbCd_pLliWd8NNw3Qsa0C4Zezfk6b6LHQIIjen5Bw,2029
244
244
  egain_api_python/models/rejectghsolutionop.py,sha256=e24KKMYYRRKUeXmfQmuaVL0VqLEW0k6ntjdGoV5ZTXE,2040
245
245
  egain_api_python/models/relatedquestions.py,sha256=-mrpY6GvMaywlW5xejN3L7CT36hGLsxfy6jqIsxtNH0,879
246
246
  egain_api_python/models/restorequickpickop.py,sha256=N9fl3zebetUpOa3JEbzLnRcArqjXtTx_QPANUYXsgSU,2791
247
- egain_api_python/models/retrievechunksop.py,sha256=EnQ-Cr_EAGMGKqTlMrer3Ub8L7wdPkslIMysSsdu8mA,3644
247
+ egain_api_python/models/retrievechunksop.py,sha256=T6QDYHccK8FxdSC8MIwBJi7CDDsD6OlnODMxvJYZkoc,3636
248
248
  egain_api_python/models/retrieverequest.py,sha256=A9mhXNdX6_tp4LndHhlIaINBJz9HQSye37DepjJSw0o,1894
249
249
  egain_api_python/models/retrieveresponse.py,sha256=HikIPFPE7tqmlTPhMRHi4j70xDdawogszzXduAFJg6Y,4190
250
250
  egain_api_python/models/role.py,sha256=aEQXpao0y3T5WbKAY04XXtbUIrNOtDsiCeRdQ9lsDbA,597
@@ -259,7 +259,7 @@ egain_api_python/models/schemas_tags.py,sha256=Z1ZAiHqxbDpbxh_p7Jh-6mYPEir9riBpT
259
259
  egain_api_python/models/schemas_wserrorcommon.py,sha256=R9OG3XOhiyet3uibAoDNGZPeq2rnPcHL0Nl0Y4OA8R0,424
260
260
  egain_api_python/models/searchfilterattribute.py,sha256=Ih4EgldWKl-QPE9VRPspiDoaMcGuuzgqMgTC44ekp4Y,2512
261
261
  egain_api_python/models/searchpriortoescalationop.py,sha256=sAiAszG3ywEqQ23Xm5US4OKSlSDraisRlUWNSS_vOyA,4807
262
- egain_api_python/models/searchresult.py,sha256=y-sysMGzKwzC3TR0wMeFqtJ5nryc15ebtzYvxqc1yRs,3331
262
+ egain_api_python/models/searchresult.py,sha256=Ohws-gaFWb_Lk8TlF3n2DYIIKk3NGRLnubNbww3j48Y,3213
263
263
  egain_api_python/models/searchsuggestionop.py,sha256=4tluMg5_fDxMXyNH1Oi4UKo5p3u4kcv2LpP-SA4iK-w,3792
264
264
  egain_api_python/models/security.py,sha256=UqCkttTO29yuwhatMKhQEeEjjbD1FtXL_SAQTrDGsao,710
265
265
  egain_api_python/models/selectuserprofileop.py,sha256=iQjtJlat8byVpk7YsE4fTfgLShwbNYaVov4p4JtV2wE,1703
@@ -323,8 +323,8 @@ egain_api_python/utils/serializers.py,sha256=Hndks5M_rJXVub_N5lu0gKZQUoEmWrn6PN7
323
323
  egain_api_python/utils/unmarshal_json_response.py,sha256=nZEaLmlsWi3z3q8Qp7ZM2jgxizRcfOBA7l8GPJuv1SY,592
324
324
  egain_api_python/utils/url.py,sha256=BgGPgcTA6MRK4bF8fjP2dUopN3NzEzxWMXPBVg8NQUA,5254
325
325
  egain_api_python/utils/values.py,sha256=CcaCXEa3xHhkUDROyXZocN8f0bdITftv9Y0P9lTf0YM,3517
326
- egain_api_python-0.1.6.dist-info/licenses/LICENSE,sha256=ICtvDBOvFUvPgUEGtnyxAarCTU0IASpQZdnv8QMnHlI,1062
327
- egain_api_python-0.1.6.dist-info/METADATA,sha256=JAFp9FjXt9myVNpLimY4bKkr0uBbJI3nU1NumQSSYVM,33248
328
- egain_api_python-0.1.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
329
- egain_api_python-0.1.6.dist-info/top_level.txt,sha256=SjFjGp6Ocutn5yM4tqZHMJwpuZxFzT6qiIcELk251PA,17
330
- egain_api_python-0.1.6.dist-info/RECORD,,
326
+ egain_api_python-0.1.7.dist-info/licenses/LICENSE,sha256=ICtvDBOvFUvPgUEGtnyxAarCTU0IASpQZdnv8QMnHlI,1062
327
+ egain_api_python-0.1.7.dist-info/METADATA,sha256=ueiF6J7dfqAUuBSx5ErHF8SOL5juZ43EUwWDRRvQtdo,33240
328
+ egain_api_python-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
329
+ egain_api_python-0.1.7.dist-info/top_level.txt,sha256=SjFjGp6Ocutn5yM4tqZHMJwpuZxFzT6qiIcELk251PA,17
330
+ egain_api_python-0.1.7.dist-info/RECORD,,