bisibility 0.2.1__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.
- bisibility/__init__.py +385 -0
- bisibility/client.py +2199 -0
- bisibility/errors.py +124 -0
- bisibility/models.py +1295 -0
- bisibility/py.typed +1 -0
- bisibility-0.2.1.dist-info/METADATA +383 -0
- bisibility-0.2.1.dist-info/RECORD +10 -0
- bisibility-0.2.1.dist-info/WHEEL +4 -0
- bisibility-0.2.1.dist-info/licenses/LICENSE +201 -0
- bisibility-0.2.1.dist-info/licenses/NOTICE +5 -0
bisibility/__init__.py
ADDED
|
@@ -0,0 +1,385 @@
|
|
|
1
|
+
from .client import BisibilityClient, RequestOptions, create_bisibility_client
|
|
2
|
+
from .errors import (
|
|
3
|
+
BisibilityApiError,
|
|
4
|
+
BisibilityConfigurationError,
|
|
5
|
+
BisibilityError,
|
|
6
|
+
BisibilityNetworkError,
|
|
7
|
+
BisibilityResponseError,
|
|
8
|
+
)
|
|
9
|
+
from .models import (
|
|
10
|
+
AddCompetitorInput,
|
|
11
|
+
AlertChannel,
|
|
12
|
+
AlertConditionType,
|
|
13
|
+
AlertRule,
|
|
14
|
+
AlertRuleDeleteResult,
|
|
15
|
+
AlertRuleInput,
|
|
16
|
+
AlertTargetType,
|
|
17
|
+
AnalyticsConnection,
|
|
18
|
+
ApiKey,
|
|
19
|
+
ApiKeyCreateInput,
|
|
20
|
+
Capability,
|
|
21
|
+
CloudImportChunkLimits,
|
|
22
|
+
CloudImportChunkResponse,
|
|
23
|
+
CloudImportCompatibility,
|
|
24
|
+
CloudImportCounts,
|
|
25
|
+
CloudImportFinalizeResponse,
|
|
26
|
+
CloudImportJob,
|
|
27
|
+
CloudImportPackage,
|
|
28
|
+
CloudImportSessionCreate,
|
|
29
|
+
CloudImportSessionCreateResponse,
|
|
30
|
+
CloudImportSessionTotals,
|
|
31
|
+
CloudImportState,
|
|
32
|
+
Competitor,
|
|
33
|
+
CompetitorColumn,
|
|
34
|
+
CompetitorListMeta,
|
|
35
|
+
CompetitorMarket,
|
|
36
|
+
CompetitorRemoveResult,
|
|
37
|
+
CompetitorShare,
|
|
38
|
+
ConnectProviderInput,
|
|
39
|
+
CostEstimate,
|
|
40
|
+
CostEstimateFrequency,
|
|
41
|
+
CostEstimateOptions,
|
|
42
|
+
CostEstimateProvider,
|
|
43
|
+
CreatedApiKey,
|
|
44
|
+
CreatedPersonalAccessToken,
|
|
45
|
+
CreatedTeamInvite,
|
|
46
|
+
CreateKeywordInput,
|
|
47
|
+
CreateKeywordItem,
|
|
48
|
+
CreateKeywordResult,
|
|
49
|
+
CreateKeywordsBatch,
|
|
50
|
+
CreateKeywordsInput,
|
|
51
|
+
CreateKeywordsResponse,
|
|
52
|
+
CreateProjectInput,
|
|
53
|
+
CreateSavedViewInput,
|
|
54
|
+
CreateSignalInput,
|
|
55
|
+
CreateTeamInviteInput,
|
|
56
|
+
DataResponse,
|
|
57
|
+
Device,
|
|
58
|
+
HeadToHeadRow,
|
|
59
|
+
HealthProviders,
|
|
60
|
+
HealthResponse,
|
|
61
|
+
HealthServices,
|
|
62
|
+
IssuedMigrationToken,
|
|
63
|
+
JsonObject,
|
|
64
|
+
Keyword,
|
|
65
|
+
KeywordBulkInput,
|
|
66
|
+
KeywordBulkItemResult,
|
|
67
|
+
KeywordBulkOperation,
|
|
68
|
+
KeywordBulkResponse,
|
|
69
|
+
KeywordIntent,
|
|
70
|
+
KeywordMetricsInput,
|
|
71
|
+
KeywordMetricsResponse,
|
|
72
|
+
KeywordMetricsRow,
|
|
73
|
+
KeywordResearchMode,
|
|
74
|
+
KeywordResearchOptions,
|
|
75
|
+
KeywordResearchResponse,
|
|
76
|
+
KeywordResearchRow,
|
|
77
|
+
KeywordResearchSource,
|
|
78
|
+
KeywordResearchSourceReason,
|
|
79
|
+
KeywordResearchSourceResult,
|
|
80
|
+
KeywordResearchSourceStatus,
|
|
81
|
+
KeywordSchedule,
|
|
82
|
+
KeywordScheduleInput,
|
|
83
|
+
KeywordSort,
|
|
84
|
+
ListCompetitorsResponse,
|
|
85
|
+
ListKeywordsOptions,
|
|
86
|
+
ListMeta,
|
|
87
|
+
ListMigrationTokensResponse,
|
|
88
|
+
ListRankChecksOptions,
|
|
89
|
+
ListRankedKeywordSuggestionsOptions,
|
|
90
|
+
ListResponse,
|
|
91
|
+
ListSearchPerformanceQueryStatsOptions,
|
|
92
|
+
ListSignalsOptions,
|
|
93
|
+
ListTrafficSnapshotsOptions,
|
|
94
|
+
LocationKind,
|
|
95
|
+
LocationSuggestion,
|
|
96
|
+
Me,
|
|
97
|
+
MeProject,
|
|
98
|
+
MigrationScope,
|
|
99
|
+
MigrationToken,
|
|
100
|
+
MigrationTokenCreator,
|
|
101
|
+
MigrationTokenListMeta,
|
|
102
|
+
MigrationTokenRevokeResult,
|
|
103
|
+
MintMigrationTokenInput,
|
|
104
|
+
MonthlyKeywordVolume,
|
|
105
|
+
NotificationPreferences,
|
|
106
|
+
NotificationPreferencesPatch,
|
|
107
|
+
OpenApiDocument,
|
|
108
|
+
PageTrafficSnapshot,
|
|
109
|
+
PageTrafficSnapshotsResponse,
|
|
110
|
+
PaginationOptions,
|
|
111
|
+
PersonalAccessToken,
|
|
112
|
+
PersonalAccessTokenCreateInput,
|
|
113
|
+
PersonalAccessTokenScope,
|
|
114
|
+
ProblemDetails,
|
|
115
|
+
Project,
|
|
116
|
+
ProjectDefaults,
|
|
117
|
+
ProjectDefaultsPatch,
|
|
118
|
+
ProjectWriteMode,
|
|
119
|
+
Provider,
|
|
120
|
+
ProviderConnection,
|
|
121
|
+
ProviderCredentialField,
|
|
122
|
+
ProviderCredentialsInput,
|
|
123
|
+
ProviderDisconnectResult,
|
|
124
|
+
ProviderDrawer,
|
|
125
|
+
ProviderDrawerDefaults,
|
|
126
|
+
ProviderId,
|
|
127
|
+
ProviderKind,
|
|
128
|
+
ProviderMetaRow,
|
|
129
|
+
ProviderPricingModel,
|
|
130
|
+
ProviderRate,
|
|
131
|
+
ProviderRateOption,
|
|
132
|
+
ProviderRatePlan,
|
|
133
|
+
ProviderSettingsInput,
|
|
134
|
+
ProviderTestResult,
|
|
135
|
+
RankCheck,
|
|
136
|
+
RankCheckAttempt,
|
|
137
|
+
RankCheckFrequency,
|
|
138
|
+
RankCheckStatus,
|
|
139
|
+
RankedKeywordConnection,
|
|
140
|
+
RankedKeywordProvider,
|
|
141
|
+
RankedKeywordSuggestion,
|
|
142
|
+
RankedKeywordSuggestionsResponse,
|
|
143
|
+
RankHistoryExportFormat,
|
|
144
|
+
RankHistoryExportOptions,
|
|
145
|
+
RankHistoryExportResponse,
|
|
146
|
+
RankHistoryExportRow,
|
|
147
|
+
RankHistoryGranularity,
|
|
148
|
+
RankHistoryRange,
|
|
149
|
+
RevokedTeamInvite,
|
|
150
|
+
RunRankCheckInput,
|
|
151
|
+
SavedView,
|
|
152
|
+
SavedViewConfig,
|
|
153
|
+
SavedViewDeleteResult,
|
|
154
|
+
SavedViewFilters,
|
|
155
|
+
SearchLocationsOptions,
|
|
156
|
+
SearchPerformanceQueryStat,
|
|
157
|
+
SearchPerformanceQueryStatsResponse,
|
|
158
|
+
Signal,
|
|
159
|
+
SignalCreateSource,
|
|
160
|
+
SignalSeverity,
|
|
161
|
+
SignalSource,
|
|
162
|
+
SitemapMonitor,
|
|
163
|
+
SitemapMonitorListResponse,
|
|
164
|
+
SitemapMonitorPatch,
|
|
165
|
+
SitemapMonitorStatus,
|
|
166
|
+
SitemapSnapshotSummary,
|
|
167
|
+
SuggestedCompetitor,
|
|
168
|
+
TeamInvite,
|
|
169
|
+
TeamInviteResendResult,
|
|
170
|
+
TeamInviteRole,
|
|
171
|
+
TeamMember,
|
|
172
|
+
TeamMemberMutationResult,
|
|
173
|
+
TeamMemberRolePatch,
|
|
174
|
+
TeamMemberRoleResult,
|
|
175
|
+
TeamRoleValue,
|
|
176
|
+
TestProviderConnectionInput,
|
|
177
|
+
TrackingScope,
|
|
178
|
+
TrafficSyncRun,
|
|
179
|
+
TrafficSyncSkipped,
|
|
180
|
+
TrafficSyncSkipReason,
|
|
181
|
+
TrafficSyncStatus,
|
|
182
|
+
TrafficSyncSummary,
|
|
183
|
+
TriggeredAlert,
|
|
184
|
+
TriggeredAlertMuteResult,
|
|
185
|
+
TriggeredAlertsReadResult,
|
|
186
|
+
UpdateKeywordInput,
|
|
187
|
+
UpdateMeInput,
|
|
188
|
+
UpdateProjectInput,
|
|
189
|
+
Webhook,
|
|
190
|
+
WebhookCreateInput,
|
|
191
|
+
WebhookUpdateInput,
|
|
192
|
+
)
|
|
193
|
+
|
|
194
|
+
__all__ = [
|
|
195
|
+
"AddCompetitorInput",
|
|
196
|
+
"AlertChannel",
|
|
197
|
+
"AlertConditionType",
|
|
198
|
+
"AlertRule",
|
|
199
|
+
"AlertRuleDeleteResult",
|
|
200
|
+
"AlertRuleInput",
|
|
201
|
+
"AlertTargetType",
|
|
202
|
+
"AnalyticsConnection",
|
|
203
|
+
"ApiKey",
|
|
204
|
+
"ApiKeyCreateInput",
|
|
205
|
+
"BisibilityApiError",
|
|
206
|
+
"BisibilityClient",
|
|
207
|
+
"BisibilityConfigurationError",
|
|
208
|
+
"BisibilityError",
|
|
209
|
+
"BisibilityNetworkError",
|
|
210
|
+
"BisibilityResponseError",
|
|
211
|
+
"Capability",
|
|
212
|
+
"CloudImportChunkLimits",
|
|
213
|
+
"CloudImportChunkResponse",
|
|
214
|
+
"CloudImportCompatibility",
|
|
215
|
+
"CloudImportCounts",
|
|
216
|
+
"CloudImportFinalizeResponse",
|
|
217
|
+
"CloudImportJob",
|
|
218
|
+
"CloudImportPackage",
|
|
219
|
+
"CloudImportSessionCreate",
|
|
220
|
+
"CloudImportSessionCreateResponse",
|
|
221
|
+
"CloudImportSessionTotals",
|
|
222
|
+
"CloudImportState",
|
|
223
|
+
"Competitor",
|
|
224
|
+
"CompetitorColumn",
|
|
225
|
+
"CompetitorListMeta",
|
|
226
|
+
"CompetitorMarket",
|
|
227
|
+
"CompetitorRemoveResult",
|
|
228
|
+
"CompetitorShare",
|
|
229
|
+
"ConnectProviderInput",
|
|
230
|
+
"CostEstimate",
|
|
231
|
+
"CostEstimateFrequency",
|
|
232
|
+
"CostEstimateOptions",
|
|
233
|
+
"CostEstimateProvider",
|
|
234
|
+
"CreateKeywordInput",
|
|
235
|
+
"CreateKeywordItem",
|
|
236
|
+
"CreateKeywordResult",
|
|
237
|
+
"CreateKeywordsBatch",
|
|
238
|
+
"CreateKeywordsInput",
|
|
239
|
+
"CreateKeywordsResponse",
|
|
240
|
+
"CreateProjectInput",
|
|
241
|
+
"CreateSavedViewInput",
|
|
242
|
+
"CreateSignalInput",
|
|
243
|
+
"CreateTeamInviteInput",
|
|
244
|
+
"CreatedApiKey",
|
|
245
|
+
"CreatedPersonalAccessToken",
|
|
246
|
+
"CreatedTeamInvite",
|
|
247
|
+
"DataResponse",
|
|
248
|
+
"Device",
|
|
249
|
+
"HeadToHeadRow",
|
|
250
|
+
"HealthProviders",
|
|
251
|
+
"HealthResponse",
|
|
252
|
+
"HealthServices",
|
|
253
|
+
"IssuedMigrationToken",
|
|
254
|
+
"JsonObject",
|
|
255
|
+
"Keyword",
|
|
256
|
+
"KeywordBulkInput",
|
|
257
|
+
"KeywordBulkItemResult",
|
|
258
|
+
"KeywordBulkOperation",
|
|
259
|
+
"KeywordBulkResponse",
|
|
260
|
+
"KeywordIntent",
|
|
261
|
+
"KeywordMetricsInput",
|
|
262
|
+
"KeywordMetricsResponse",
|
|
263
|
+
"KeywordMetricsRow",
|
|
264
|
+
"KeywordResearchMode",
|
|
265
|
+
"KeywordResearchOptions",
|
|
266
|
+
"KeywordResearchResponse",
|
|
267
|
+
"KeywordResearchRow",
|
|
268
|
+
"KeywordResearchSource",
|
|
269
|
+
"KeywordResearchSourceReason",
|
|
270
|
+
"KeywordResearchSourceResult",
|
|
271
|
+
"KeywordResearchSourceStatus",
|
|
272
|
+
"KeywordSchedule",
|
|
273
|
+
"KeywordScheduleInput",
|
|
274
|
+
"KeywordSort",
|
|
275
|
+
"ListCompetitorsResponse",
|
|
276
|
+
"ListKeywordsOptions",
|
|
277
|
+
"ListMeta",
|
|
278
|
+
"ListMigrationTokensResponse",
|
|
279
|
+
"ListRankChecksOptions",
|
|
280
|
+
"ListRankedKeywordSuggestionsOptions",
|
|
281
|
+
"ListResponse",
|
|
282
|
+
"ListSearchPerformanceQueryStatsOptions",
|
|
283
|
+
"ListSignalsOptions",
|
|
284
|
+
"ListTrafficSnapshotsOptions",
|
|
285
|
+
"LocationKind",
|
|
286
|
+
"LocationSuggestion",
|
|
287
|
+
"Me",
|
|
288
|
+
"MeProject",
|
|
289
|
+
"MigrationScope",
|
|
290
|
+
"MigrationToken",
|
|
291
|
+
"MigrationTokenCreator",
|
|
292
|
+
"MigrationTokenListMeta",
|
|
293
|
+
"MigrationTokenRevokeResult",
|
|
294
|
+
"MintMigrationTokenInput",
|
|
295
|
+
"MonthlyKeywordVolume",
|
|
296
|
+
"NotificationPreferences",
|
|
297
|
+
"NotificationPreferencesPatch",
|
|
298
|
+
"OpenApiDocument",
|
|
299
|
+
"PageTrafficSnapshot",
|
|
300
|
+
"PageTrafficSnapshotsResponse",
|
|
301
|
+
"PaginationOptions",
|
|
302
|
+
"PersonalAccessToken",
|
|
303
|
+
"PersonalAccessTokenCreateInput",
|
|
304
|
+
"PersonalAccessTokenScope",
|
|
305
|
+
"ProblemDetails",
|
|
306
|
+
"Project",
|
|
307
|
+
"ProjectDefaults",
|
|
308
|
+
"ProjectDefaultsPatch",
|
|
309
|
+
"ProjectWriteMode",
|
|
310
|
+
"Provider",
|
|
311
|
+
"ProviderConnection",
|
|
312
|
+
"ProviderCredentialField",
|
|
313
|
+
"ProviderCredentialsInput",
|
|
314
|
+
"ProviderDisconnectResult",
|
|
315
|
+
"ProviderDrawer",
|
|
316
|
+
"ProviderDrawerDefaults",
|
|
317
|
+
"ProviderId",
|
|
318
|
+
"ProviderKind",
|
|
319
|
+
"ProviderMetaRow",
|
|
320
|
+
"ProviderPricingModel",
|
|
321
|
+
"ProviderRate",
|
|
322
|
+
"ProviderRateOption",
|
|
323
|
+
"ProviderRatePlan",
|
|
324
|
+
"ProviderSettingsInput",
|
|
325
|
+
"ProviderTestResult",
|
|
326
|
+
"RankCheck",
|
|
327
|
+
"RankCheckAttempt",
|
|
328
|
+
"RankCheckFrequency",
|
|
329
|
+
"RankCheckStatus",
|
|
330
|
+
"RankHistoryExportFormat",
|
|
331
|
+
"RankHistoryExportOptions",
|
|
332
|
+
"RankHistoryExportResponse",
|
|
333
|
+
"RankHistoryExportRow",
|
|
334
|
+
"RankHistoryGranularity",
|
|
335
|
+
"RankHistoryRange",
|
|
336
|
+
"RankedKeywordConnection",
|
|
337
|
+
"RankedKeywordProvider",
|
|
338
|
+
"RankedKeywordSuggestion",
|
|
339
|
+
"RankedKeywordSuggestionsResponse",
|
|
340
|
+
"RequestOptions",
|
|
341
|
+
"RevokedTeamInvite",
|
|
342
|
+
"RunRankCheckInput",
|
|
343
|
+
"SavedView",
|
|
344
|
+
"SavedViewConfig",
|
|
345
|
+
"SavedViewDeleteResult",
|
|
346
|
+
"SavedViewFilters",
|
|
347
|
+
"SearchLocationsOptions",
|
|
348
|
+
"SearchPerformanceQueryStat",
|
|
349
|
+
"SearchPerformanceQueryStatsResponse",
|
|
350
|
+
"Signal",
|
|
351
|
+
"SignalCreateSource",
|
|
352
|
+
"SignalSeverity",
|
|
353
|
+
"SignalSource",
|
|
354
|
+
"SitemapMonitor",
|
|
355
|
+
"SitemapMonitorListResponse",
|
|
356
|
+
"SitemapMonitorPatch",
|
|
357
|
+
"SitemapMonitorStatus",
|
|
358
|
+
"SitemapSnapshotSummary",
|
|
359
|
+
"SuggestedCompetitor",
|
|
360
|
+
"TeamInvite",
|
|
361
|
+
"TeamInviteResendResult",
|
|
362
|
+
"TeamInviteRole",
|
|
363
|
+
"TeamMember",
|
|
364
|
+
"TeamMemberMutationResult",
|
|
365
|
+
"TeamMemberRolePatch",
|
|
366
|
+
"TeamMemberRoleResult",
|
|
367
|
+
"TeamRoleValue",
|
|
368
|
+
"TestProviderConnectionInput",
|
|
369
|
+
"TrackingScope",
|
|
370
|
+
"TrafficSyncRun",
|
|
371
|
+
"TrafficSyncSkipReason",
|
|
372
|
+
"TrafficSyncSkipped",
|
|
373
|
+
"TrafficSyncStatus",
|
|
374
|
+
"TrafficSyncSummary",
|
|
375
|
+
"TriggeredAlert",
|
|
376
|
+
"TriggeredAlertMuteResult",
|
|
377
|
+
"TriggeredAlertsReadResult",
|
|
378
|
+
"UpdateKeywordInput",
|
|
379
|
+
"UpdateMeInput",
|
|
380
|
+
"UpdateProjectInput",
|
|
381
|
+
"Webhook",
|
|
382
|
+
"WebhookCreateInput",
|
|
383
|
+
"WebhookUpdateInput",
|
|
384
|
+
"create_bisibility_client",
|
|
385
|
+
]
|