athena-intelligence 0.1.81__py3-none-any.whl → 0.1.83__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.
athena/search/client.py CHANGED
@@ -34,21 +34,30 @@ class SearchClient:
34
34
  request_options: typing.Optional[RequestOptions] = None,
35
35
  ) -> UrlResult:
36
36
  """
37
- Parameters:
38
- - query: str.
37
+ Parameters
38
+ ----------
39
+ query : str
39
40
 
40
- - num_urls: int.
41
+ num_urls : int
41
42
 
42
- - tbs: str.
43
+ tbs : str
43
44
 
44
- - country_code: typing.Optional[str].
45
+ country_code : typing.Optional[str]
45
46
 
46
- - country_restrict: typing.Optional[str].
47
+ country_restrict : typing.Optional[str]
47
48
 
48
- - site: typing.Optional[str].
49
+ site : typing.Optional[str]
49
50
 
50
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
51
- ---
51
+ request_options : typing.Optional[RequestOptions]
52
+ Request-specific configuration.
53
+
54
+ Returns
55
+ -------
56
+ UrlResult
57
+ Successful Response
58
+
59
+ Examples
60
+ --------
52
61
  from athena.client import Athena
53
62
 
54
63
  client = Athena(
@@ -122,21 +131,30 @@ class AsyncSearchClient:
122
131
  request_options: typing.Optional[RequestOptions] = None,
123
132
  ) -> UrlResult:
124
133
  """
125
- Parameters:
126
- - query: str.
134
+ Parameters
135
+ ----------
136
+ query : str
137
+
138
+ num_urls : int
139
+
140
+ tbs : str
127
141
 
128
- - num_urls: int.
142
+ country_code : typing.Optional[str]
129
143
 
130
- - tbs: str.
144
+ country_restrict : typing.Optional[str]
131
145
 
132
- - country_code: typing.Optional[str].
146
+ site : typing.Optional[str]
133
147
 
134
- - country_restrict: typing.Optional[str].
148
+ request_options : typing.Optional[RequestOptions]
149
+ Request-specific configuration.
135
150
 
136
- - site: typing.Optional[str].
151
+ Returns
152
+ -------
153
+ UrlResult
154
+ Successful Response
137
155
 
138
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
139
- ---
156
+ Examples
157
+ --------
140
158
  from athena.client import AsyncAthena
141
159
 
142
160
  client = AsyncAthena(
athena/snippet/client.py CHANGED
@@ -31,13 +31,24 @@ class SnippetClient:
31
31
  request_options: typing.Optional[RequestOptions] = None,
32
32
  ) -> GetSnippetsResponse:
33
33
  """
34
- Parameters:
35
- - page: typing.Optional[int]. Page number starting from 1
34
+ Parameters
35
+ ----------
36
+ page : typing.Optional[int]
37
+ Page number starting from 1
36
38
 
37
- - page_size: typing.Optional[int]. Number of items per page
39
+ page_size : typing.Optional[int]
40
+ Number of items per page
38
41
 
39
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
40
- ---
42
+ request_options : typing.Optional[RequestOptions]
43
+ Request-specific configuration.
44
+
45
+ Returns
46
+ -------
47
+ GetSnippetsResponse
48
+ Successful Response
49
+
50
+ Examples
51
+ --------
41
52
  from athena.client import Athena
42
53
 
43
54
  client = Athena(
@@ -89,11 +100,20 @@ class SnippetClient:
89
100
 
90
101
  def get_by_id(self, *, id: str, request_options: typing.Optional[RequestOptions] = None) -> GetSnippetOut:
91
102
  """
92
- Parameters:
93
- - id: str.
103
+ Parameters
104
+ ----------
105
+ id : str
106
+
107
+ request_options : typing.Optional[RequestOptions]
108
+ Request-specific configuration.
109
+
110
+ Returns
111
+ -------
112
+ GetSnippetOut
113
+ Successful Response
94
114
 
95
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
96
- ---
115
+ Examples
116
+ --------
97
117
  from athena.client import Athena
98
118
 
99
119
  client = Athena(
@@ -154,13 +174,24 @@ class AsyncSnippetClient:
154
174
  request_options: typing.Optional[RequestOptions] = None,
155
175
  ) -> GetSnippetsResponse:
156
176
  """
157
- Parameters:
158
- - page: typing.Optional[int]. Page number starting from 1
177
+ Parameters
178
+ ----------
179
+ page : typing.Optional[int]
180
+ Page number starting from 1
159
181
 
160
- - page_size: typing.Optional[int]. Number of items per page
182
+ page_size : typing.Optional[int]
183
+ Number of items per page
161
184
 
162
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
163
- ---
185
+ request_options : typing.Optional[RequestOptions]
186
+ Request-specific configuration.
187
+
188
+ Returns
189
+ -------
190
+ GetSnippetsResponse
191
+ Successful Response
192
+
193
+ Examples
194
+ --------
164
195
  from athena.client import AsyncAthena
165
196
 
166
197
  client = AsyncAthena(
@@ -212,11 +243,20 @@ class AsyncSnippetClient:
212
243
 
213
244
  async def get_by_id(self, *, id: str, request_options: typing.Optional[RequestOptions] = None) -> GetSnippetOut:
214
245
  """
215
- Parameters:
216
- - id: str.
246
+ Parameters
247
+ ----------
248
+ id : str
249
+
250
+ request_options : typing.Optional[RequestOptions]
251
+ Request-specific configuration.
252
+
253
+ Returns
254
+ -------
255
+ GetSnippetOut
256
+ Successful Response
217
257
 
218
- - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
219
- ---
258
+ Examples
259
+ --------
220
260
  from athena.client import AsyncAthena
221
261
 
222
262
  client = AsyncAthena(