spatialflow 0.1.0__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.
- spatialflow/__init__.py +91 -0
- spatialflow/_generated/.github/workflows/python.yml +31 -0
- spatialflow/_generated/.gitignore +66 -0
- spatialflow/_generated/.gitlab-ci.yml +31 -0
- spatialflow/_generated/.openapi-generator/FILES +390 -0
- spatialflow/_generated/.openapi-generator/VERSION +1 -0
- spatialflow/_generated/.openapi-generator-ignore +23 -0
- spatialflow/_generated/.spec-hash +1 -0
- spatialflow/_generated/.travis.yml +17 -0
- spatialflow/_generated/README.md +537 -0
- spatialflow/_generated/__init__.py +1 -0
- spatialflow/_generated/docs/APIUsageStats.md +32 -0
- spatialflow/_generated/docs/AccountApi.md +1751 -0
- spatialflow/_generated/docs/ActionDeliverySuccessMetrics.md +32 -0
- spatialflow/_generated/docs/ActionResponse.md +32 -0
- spatialflow/_generated/docs/ActionRetryConfigSchema.md +32 -0
- spatialflow/_generated/docs/ActivitySummary.md +30 -0
- spatialflow/_generated/docs/AdminApi.md +1787 -0
- spatialflow/_generated/docs/ApiKeyCreateRequest.md +31 -0
- spatialflow/_generated/docs/ApiKeyCreateResponse.md +31 -0
- spatialflow/_generated/docs/ApiKeyResponse.md +38 -0
- spatialflow/_generated/docs/ApiKeyUpdateRequest.md +33 -0
- spatialflow/_generated/docs/AsyncUploadGeofencesResponse.md +33 -0
- spatialflow/_generated/docs/AuthTypeEnum.md +17 -0
- spatialflow/_generated/docs/AuthenticationApi.md +1289 -0
- spatialflow/_generated/docs/BatchLocationUpdateIn.md +30 -0
- spatialflow/_generated/docs/BillingApi.md +925 -0
- spatialflow/_generated/docs/BulkGeofenceRequest.md +29 -0
- spatialflow/_generated/docs/ChangePasswordSchema.md +30 -0
- spatialflow/_generated/docs/CheckoutSessionRequest.md +32 -0
- spatialflow/_generated/docs/CheckoutSessionResponse.md +31 -0
- spatialflow/_generated/docs/CircuitBreakerSchema.md +33 -0
- spatialflow/_generated/docs/ConfigFieldDefinitionRequest.md +41 -0
- spatialflow/_generated/docs/ConfigFieldDefinitionResponse.md +43 -0
- spatialflow/_generated/docs/ConfirmPasswordResetSchema.md +31 -0
- spatialflow/_generated/docs/CreateFromTemplateIn.md +30 -0
- spatialflow/_generated/docs/CreateGeofenceRequest.md +36 -0
- spatialflow/_generated/docs/CreateIntegrationSchema.md +33 -0
- spatialflow/_generated/docs/CreateUserSchema.md +35 -0
- spatialflow/_generated/docs/CreateWebhookRequest.md +43 -0
- spatialflow/_generated/docs/DashboardComparisonMetrics.md +32 -0
- spatialflow/_generated/docs/DashboardMetricsResponse.md +36 -0
- spatialflow/_generated/docs/DefaultApi.md +585 -0
- spatialflow/_generated/docs/DeleteFileResponse.md +30 -0
- spatialflow/_generated/docs/DeliveryStatusEnum.md +15 -0
- spatialflow/_generated/docs/DeviceIn.md +32 -0
- spatialflow/_generated/docs/DeviceOut.md +37 -0
- spatialflow/_generated/docs/DevicesApi.md +1213 -0
- spatialflow/_generated/docs/E2ETestApi.md +271 -0
- spatialflow/_generated/docs/EmailApi.md +541 -0
- spatialflow/_generated/docs/EmailHealthResponse.md +31 -0
- spatialflow/_generated/docs/EmailQueueStats.md +34 -0
- spatialflow/_generated/docs/EmailStats.md +31 -0
- spatialflow/_generated/docs/EmailStatusResponse.md +36 -0
- spatialflow/_generated/docs/ErrorResponse.md +32 -0
- spatialflow/_generated/docs/ExecutionOut.md +38 -0
- spatialflow/_generated/docs/ExportIntegrationSchema.md +35 -0
- spatialflow/_generated/docs/FileListResponse.md +31 -0
- spatialflow/_generated/docs/ForgotPasswordSchema.md +29 -0
- spatialflow/_generated/docs/GPXPlaybackOut.md +42 -0
- spatialflow/_generated/docs/GPXRouteOut.md +40 -0
- spatialflow/_generated/docs/GPXSimulatorApi.md +883 -0
- spatialflow/_generated/docs/GeoJSONPoint.md +31 -0
- spatialflow/_generated/docs/GeofenceListResponse.md +31 -0
- spatialflow/_generated/docs/GeofenceResponse.md +43 -0
- spatialflow/_generated/docs/GeofenceStats.md +30 -0
- spatialflow/_generated/docs/GeofenceTestResult.md +33 -0
- spatialflow/_generated/docs/GeofencesApi.md +1524 -0
- spatialflow/_generated/docs/HealthCheckResponse.md +31 -0
- spatialflow/_generated/docs/HealthResponse.md +32 -0
- spatialflow/_generated/docs/ImportIntegrationSchema.md +32 -0
- spatialflow/_generated/docs/ImportResultSchema.md +33 -0
- spatialflow/_generated/docs/IntegrationDetailSchema.md +44 -0
- spatialflow/_generated/docs/IntegrationResponseSchema.md +42 -0
- spatialflow/_generated/docs/IntegrationStatsSchema.md +36 -0
- spatialflow/_generated/docs/IntegrationTypeListResponse.md +34 -0
- spatialflow/_generated/docs/IntegrationTypeRequest.md +40 -0
- spatialflow/_generated/docs/IntegrationTypeResponse.md +45 -0
- spatialflow/_generated/docs/IntegrationsApi.md +2008 -0
- spatialflow/_generated/docs/InvoiceLineItem.md +33 -0
- spatialflow/_generated/docs/InvoiceListResponse.md +31 -0
- spatialflow/_generated/docs/InvoiceResponse.md +40 -0
- spatialflow/_generated/docs/LocationBatchIn.md +31 -0
- spatialflow/_generated/docs/LocationImportResponse.md +41 -0
- spatialflow/_generated/docs/LocationIngestResponse.md +35 -0
- spatialflow/_generated/docs/LocationPointIn.md +38 -0
- spatialflow/_generated/docs/LocationUpdateIn.md +36 -0
- spatialflow/_generated/docs/LocationUpdateOut.md +32 -0
- spatialflow/_generated/docs/LoginResponse.md +33 -0
- spatialflow/_generated/docs/LoginSchema.md +30 -0
- spatialflow/_generated/docs/MemberActionResponse.md +33 -0
- spatialflow/_generated/docs/MemberSummary.md +36 -0
- spatialflow/_generated/docs/MethodEnum.md +17 -0
- spatialflow/_generated/docs/OAuthAuthorizeResponse.md +29 -0
- spatialflow/_generated/docs/OAuthCallbackQuery.md +32 -0
- spatialflow/_generated/docs/OAuthLinkResponse.md +31 -0
- spatialflow/_generated/docs/OAuthProvidersResponse.md +29 -0
- spatialflow/_generated/docs/OnboardingProgressResponse.md +37 -0
- spatialflow/_generated/docs/PaymentMethodResponse.md +37 -0
- spatialflow/_generated/docs/PingResponse.md +31 -0
- spatialflow/_generated/docs/PlanChangePreviewResponse.md +35 -0
- spatialflow/_generated/docs/PlanFeatures.md +36 -0
- spatialflow/_generated/docs/PlanLimits.md +34 -0
- spatialflow/_generated/docs/PlanResponse.md +37 -0
- spatialflow/_generated/docs/PortalSessionRequest.md +30 -0
- spatialflow/_generated/docs/PortalSessionResponse.md +30 -0
- spatialflow/_generated/docs/PresignedUrlRequest.md +31 -0
- spatialflow/_generated/docs/PresignedUrlResponse.md +35 -0
- spatialflow/_generated/docs/PrivacyErasureRequest.md +35 -0
- spatialflow/_generated/docs/PrivacyErasureResponse.md +36 -0
- spatialflow/_generated/docs/PublicApi.md +389 -0
- spatialflow/_generated/docs/PublicLocationIngestApi.md +249 -0
- spatialflow/_generated/docs/RateLimitResponse.md +32 -0
- spatialflow/_generated/docs/RecentActivity.md +31 -0
- spatialflow/_generated/docs/RefreshTokenSchema.md +29 -0
- spatialflow/_generated/docs/RegisterSchema.md +37 -0
- spatialflow/_generated/docs/ResendVerificationSchema.md +29 -0
- spatialflow/_generated/docs/ResetPasswordSchema.md +31 -0
- spatialflow/_generated/docs/RetryPolicyResponseSchema.md +32 -0
- spatialflow/_generated/docs/RetryPolicySchema.md +35 -0
- spatialflow/_generated/docs/RetryStrategyEnum.md +14 -0
- spatialflow/_generated/docs/SeedDataResponseSchema.md +31 -0
- spatialflow/_generated/docs/SendEmailRequest.md +33 -0
- spatialflow/_generated/docs/SetupIntentResponse.md +30 -0
- spatialflow/_generated/docs/SignupRequest.md +40 -0
- spatialflow/_generated/docs/StartPlaybackRequest.md +30 -0
- spatialflow/_generated/docs/StorageApi.md +494 -0
- spatialflow/_generated/docs/SubscriptionActionResponse.md +32 -0
- spatialflow/_generated/docs/SubscriptionResponse.md +36 -0
- spatialflow/_generated/docs/SubscriptionsApi.md +677 -0
- spatialflow/_generated/docs/SuccessResponse.md +31 -0
- spatialflow/_generated/docs/SystemApi.md +137 -0
- spatialflow/_generated/docs/TemplateOut.md +35 -0
- spatialflow/_generated/docs/TestEventRequest.md +29 -0
- spatialflow/_generated/docs/TestIntegrationResponseSchema.md +31 -0
- spatialflow/_generated/docs/TestPointRequest.md +34 -0
- spatialflow/_generated/docs/TestPointResponse.md +33 -0
- spatialflow/_generated/docs/TestWebhookRequest.md +32 -0
- spatialflow/_generated/docs/TestWorkflowIn.md +29 -0
- spatialflow/_generated/docs/TileMetadata.md +36 -0
- spatialflow/_generated/docs/TilesApi.md +462 -0
- spatialflow/_generated/docs/UnsubscribeRequest.md +29 -0
- spatialflow/_generated/docs/UnsubscribeResponse.md +31 -0
- spatialflow/_generated/docs/UpdateGeofenceRequest.md +37 -0
- spatialflow/_generated/docs/UpdateIntegrationSchema.md +33 -0
- spatialflow/_generated/docs/UpdateMemberRoleRequest.md +30 -0
- spatialflow/_generated/docs/UpdateOnboardingProgressRequest.md +30 -0
- spatialflow/_generated/docs/UpdateProfileRequest.md +45 -0
- spatialflow/_generated/docs/UpdateUserWorkspaceRequest.md +31 -0
- spatialflow/_generated/docs/UpdateWebhookRequest.md +43 -0
- spatialflow/_generated/docs/UploadGeofencesRequest.md +31 -0
- spatialflow/_generated/docs/UploadJobStatus.md +42 -0
- spatialflow/_generated/docs/UsageMetrics.md +33 -0
- spatialflow/_generated/docs/UsageResponse.md +36 -0
- spatialflow/_generated/docs/UsageStats.md +32 -0
- spatialflow/_generated/docs/UserActionResponse.md +35 -0
- spatialflow/_generated/docs/UserApprovalRequest.md +30 -0
- spatialflow/_generated/docs/UserInviteRequest.md +33 -0
- spatialflow/_generated/docs/UserInviteResponse.md +36 -0
- spatialflow/_generated/docs/UserListResponse.md +34 -0
- spatialflow/_generated/docs/UserProfileResponse.md +55 -0
- spatialflow/_generated/docs/UserRejectionRequest.md +30 -0
- spatialflow/_generated/docs/UserResponse.md +44 -0
- spatialflow/_generated/docs/UserSummary.md +41 -0
- spatialflow/_generated/docs/UserUsageResponse.md +38 -0
- spatialflow/_generated/docs/UserWorkspaceResponse.md +34 -0
- spatialflow/_generated/docs/WebhookDeliveryDetailResponse.md +49 -0
- spatialflow/_generated/docs/WebhookDeliveryListResponse.md +31 -0
- spatialflow/_generated/docs/WebhookDeliveryResponse.md +46 -0
- spatialflow/_generated/docs/WebhookListResponse.md +31 -0
- spatialflow/_generated/docs/WebhookMetricsResponse.md +31 -0
- spatialflow/_generated/docs/WebhookResponse.md +50 -0
- spatialflow/_generated/docs/WebhookTestResponse.md +36 -0
- spatialflow/_generated/docs/WebhooksApi.md +1384 -0
- spatialflow/_generated/docs/WorkflowImportSchema.md +30 -0
- spatialflow/_generated/docs/WorkflowIn.md +32 -0
- spatialflow/_generated/docs/WorkflowListOut.md +39 -0
- spatialflow/_generated/docs/WorkflowListResponse.md +32 -0
- spatialflow/_generated/docs/WorkflowOut.md +42 -0
- spatialflow/_generated/docs/WorkflowRetryPolicyUpdateSchema.md +32 -0
- spatialflow/_generated/docs/WorkflowStepRetrySchema.md +33 -0
- spatialflow/_generated/docs/WorkflowUpdate.md +33 -0
- spatialflow/_generated/docs/WorkflowsApi.md +2599 -0
- spatialflow/_generated/docs/WorkspaceDeleteResponse.md +33 -0
- spatialflow/_generated/docs/WorkspaceDetail.md +37 -0
- spatialflow/_generated/docs/WorkspaceDetailResponse.md +41 -0
- spatialflow/_generated/docs/WorkspaceIn.md +34 -0
- spatialflow/_generated/docs/WorkspaceListItem.md +39 -0
- spatialflow/_generated/docs/WorkspaceListResponse.md +34 -0
- spatialflow/_generated/docs/WorkspaceMembersResponse.md +35 -0
- spatialflow/_generated/docs/WorkspaceOut.md +38 -0
- spatialflow/_generated/docs/WorkspaceSummary.md +32 -0
- spatialflow/_generated/docs/WorkspaceUpdateRequest.md +34 -0
- spatialflow/_generated/docs/WorkspaceUpdateResponse.md +33 -0
- spatialflow/_generated/docs/WorkspacesApi.md +241 -0
- spatialflow/_generated/git_push.sh +57 -0
- spatialflow/_generated/pyproject.toml +91 -0
- spatialflow/_generated/requirements.txt +6 -0
- spatialflow/_generated/setup.cfg +2 -0
- spatialflow/_generated/setup.py +51 -0
- spatialflow/_generated/spatialflow_generated/__init__.py +216 -0
- spatialflow/_generated/spatialflow_generated/api/__init__.py +24 -0
- spatialflow/_generated/spatialflow_generated/api/account_api.py +5675 -0
- spatialflow/_generated/spatialflow_generated/api/admin_api.py +6173 -0
- spatialflow/_generated/spatialflow_generated/api/authentication_api.py +4753 -0
- spatialflow/_generated/spatialflow_generated/api/billing_api.py +3151 -0
- spatialflow/_generated/spatialflow_generated/api/default_api.py +2157 -0
- spatialflow/_generated/spatialflow_generated/api/devices_api.py +3965 -0
- spatialflow/_generated/spatialflow_generated/api/e2_e_test_api.py +1049 -0
- spatialflow/_generated/spatialflow_generated/api/email_api.py +1879 -0
- spatialflow/_generated/spatialflow_generated/api/geofences_api.py +4899 -0
- spatialflow/_generated/spatialflow_generated/api/gpx_simulator_api.py +2824 -0
- spatialflow/_generated/spatialflow_generated/api/integrations_api.py +6952 -0
- spatialflow/_generated/spatialflow_generated/api/public_api.py +1506 -0
- spatialflow/_generated/spatialflow_generated/api/public_location_ingest_api.py +845 -0
- spatialflow/_generated/spatialflow_generated/api/storage_api.py +1642 -0
- spatialflow/_generated/spatialflow_generated/api/subscriptions_api.py +2356 -0
- spatialflow/_generated/spatialflow_generated/api/system_api.py +529 -0
- spatialflow/_generated/spatialflow_generated/api/tiles_api.py +1626 -0
- spatialflow/_generated/spatialflow_generated/api/webhooks_api.py +4579 -0
- spatialflow/_generated/spatialflow_generated/api/workflows_api.py +8334 -0
- spatialflow/_generated/spatialflow_generated/api/workspaces_api.py +813 -0
- spatialflow/_generated/spatialflow_generated/api_client.py +800 -0
- spatialflow/_generated/spatialflow_generated/api_response.py +21 -0
- spatialflow/_generated/spatialflow_generated/configuration.py +599 -0
- spatialflow/_generated/spatialflow_generated/exceptions.py +199 -0
- spatialflow/_generated/spatialflow_generated/models/__init__.py +180 -0
- spatialflow/_generated/spatialflow_generated/models/action_delivery_success_metrics.py +96 -0
- spatialflow/_generated/spatialflow_generated/models/action_response.py +96 -0
- spatialflow/_generated/spatialflow_generated/models/action_retry_config_schema.py +114 -0
- spatialflow/_generated/spatialflow_generated/models/activity_summary.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/api_key_create_request.py +95 -0
- spatialflow/_generated/spatialflow_generated/models/api_key_create_response.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/api_key_response.py +109 -0
- spatialflow/_generated/spatialflow_generated/models/api_key_update_request.py +114 -0
- spatialflow/_generated/spatialflow_generated/models/api_usage_stats.py +98 -0
- spatialflow/_generated/spatialflow_generated/models/async_upload_geofences_response.py +93 -0
- spatialflow/_generated/spatialflow_generated/models/auth_type_enum.py +39 -0
- spatialflow/_generated/spatialflow_generated/models/batch_location_update_in.py +97 -0
- spatialflow/_generated/spatialflow_generated/models/bulk_geofence_request.py +95 -0
- spatialflow/_generated/spatialflow_generated/models/change_password_schema.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/checkout_session_request.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/checkout_session_response.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/circuit_breaker_schema.py +94 -0
- spatialflow/_generated/spatialflow_generated/models/config_field_definition_request.py +134 -0
- spatialflow/_generated/spatialflow_generated/models/config_field_definition_response.py +138 -0
- spatialflow/_generated/spatialflow_generated/models/confirm_password_reset_schema.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/create_from_template_in.py +94 -0
- spatialflow/_generated/spatialflow_generated/models/create_geofence_request.py +125 -0
- spatialflow/_generated/spatialflow_generated/models/create_integration_schema.py +106 -0
- spatialflow/_generated/spatialflow_generated/models/create_user_schema.py +99 -0
- spatialflow/_generated/spatialflow_generated/models/create_webhook_request.py +136 -0
- spatialflow/_generated/spatialflow_generated/models/dashboard_comparison_metrics.py +96 -0
- spatialflow/_generated/spatialflow_generated/models/dashboard_metrics_response.py +108 -0
- spatialflow/_generated/spatialflow_generated/models/delete_file_response.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/delivery_status_enum.py +38 -0
- spatialflow/_generated/spatialflow_generated/models/device_in.py +98 -0
- spatialflow/_generated/spatialflow_generated/models/device_out.py +114 -0
- spatialflow/_generated/spatialflow_generated/models/email_health_response.py +92 -0
- spatialflow/_generated/spatialflow_generated/models/email_queue_stats.py +97 -0
- spatialflow/_generated/spatialflow_generated/models/email_stats.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/email_status_response.py +112 -0
- spatialflow/_generated/spatialflow_generated/models/error_response.py +101 -0
- spatialflow/_generated/spatialflow_generated/models/execution_out.py +126 -0
- spatialflow/_generated/spatialflow_generated/models/export_integration_schema.py +97 -0
- spatialflow/_generated/spatialflow_generated/models/file_list_response.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/forgot_password_schema.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/geo_json_point.py +97 -0
- spatialflow/_generated/spatialflow_generated/models/geofence_list_response.py +97 -0
- spatialflow/_generated/spatialflow_generated/models/geofence_response.py +139 -0
- spatialflow/_generated/spatialflow_generated/models/geofence_stats.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/geofence_test_result.py +98 -0
- spatialflow/_generated/spatialflow_generated/models/gpx_playback_out.py +128 -0
- spatialflow/_generated/spatialflow_generated/models/gpx_route_out.py +119 -0
- spatialflow/_generated/spatialflow_generated/models/health_check_response.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/health_response.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/import_integration_schema.py +100 -0
- spatialflow/_generated/spatialflow_generated/models/import_result_schema.py +103 -0
- spatialflow/_generated/spatialflow_generated/models/integration_detail_schema.py +125 -0
- spatialflow/_generated/spatialflow_generated/models/integration_response_schema.py +123 -0
- spatialflow/_generated/spatialflow_generated/models/integration_stats_schema.py +116 -0
- spatialflow/_generated/spatialflow_generated/models/integration_type_list_response.py +103 -0
- spatialflow/_generated/spatialflow_generated/models/integration_type_request.py +117 -0
- spatialflow/_generated/spatialflow_generated/models/integration_type_response.py +128 -0
- spatialflow/_generated/spatialflow_generated/models/invoice_line_item.py +93 -0
- spatialflow/_generated/spatialflow_generated/models/invoice_list_response.py +97 -0
- spatialflow/_generated/spatialflow_generated/models/invoice_response.py +120 -0
- spatialflow/_generated/spatialflow_generated/models/location_batch_in.py +102 -0
- spatialflow/_generated/spatialflow_generated/models/location_import_response.py +120 -0
- spatialflow/_generated/spatialflow_generated/models/location_ingest_response.py +117 -0
- spatialflow/_generated/spatialflow_generated/models/location_point_in.py +129 -0
- spatialflow/_generated/spatialflow_generated/models/location_update_in.py +132 -0
- spatialflow/_generated/spatialflow_generated/models/location_update_out.py +93 -0
- spatialflow/_generated/spatialflow_generated/models/login_response.py +95 -0
- spatialflow/_generated/spatialflow_generated/models/login_schema.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/member_action_response.py +98 -0
- spatialflow/_generated/spatialflow_generated/models/member_summary.py +114 -0
- spatialflow/_generated/spatialflow_generated/models/method_enum.py +39 -0
- spatialflow/_generated/spatialflow_generated/models/o_auth_authorize_response.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/o_auth_callback_query.py +103 -0
- spatialflow/_generated/spatialflow_generated/models/o_auth_link_response.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/o_auth_providers_response.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/onboarding_progress_response.py +112 -0
- spatialflow/_generated/spatialflow_generated/models/payment_method_response.py +116 -0
- spatialflow/_generated/spatialflow_generated/models/ping_response.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/plan_change_preview_response.py +104 -0
- spatialflow/_generated/spatialflow_generated/models/plan_features.py +109 -0
- spatialflow/_generated/spatialflow_generated/models/plan_limits.py +95 -0
- spatialflow/_generated/spatialflow_generated/models/plan_response.py +114 -0
- spatialflow/_generated/spatialflow_generated/models/portal_session_request.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/portal_session_response.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/presigned_url_request.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/presigned_url_response.py +99 -0
- spatialflow/_generated/spatialflow_generated/models/privacy_erasure_request.py +118 -0
- spatialflow/_generated/spatialflow_generated/models/privacy_erasure_response.py +110 -0
- spatialflow/_generated/spatialflow_generated/models/rate_limit_response.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/recent_activity.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/refresh_token_schema.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/register_schema.py +133 -0
- spatialflow/_generated/spatialflow_generated/models/resend_verification_schema.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/reset_password_schema.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/retry_policy_response_schema.py +95 -0
- spatialflow/_generated/spatialflow_generated/models/retry_policy_schema.py +99 -0
- spatialflow/_generated/spatialflow_generated/models/retry_strategy_enum.py +38 -0
- spatialflow/_generated/spatialflow_generated/models/seed_data_response_schema.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/send_email_request.py +100 -0
- spatialflow/_generated/spatialflow_generated/models/setup_intent_response.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/signup_request.py +164 -0
- spatialflow/_generated/spatialflow_generated/models/start_playback_request.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/subscription_action_response.py +100 -0
- spatialflow/_generated/spatialflow_generated/models/subscription_response.py +113 -0
- spatialflow/_generated/spatialflow_generated/models/success_response.py +94 -0
- spatialflow/_generated/spatialflow_generated/models/template_out.py +104 -0
- spatialflow/_generated/spatialflow_generated/models/test_event_request.py +92 -0
- spatialflow/_generated/spatialflow_generated/models/test_integration_response_schema.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/test_point_request.py +125 -0
- spatialflow/_generated/spatialflow_generated/models/test_point_response.py +101 -0
- spatialflow/_generated/spatialflow_generated/models/test_webhook_request.py +106 -0
- spatialflow/_generated/spatialflow_generated/models/test_workflow_in.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/tile_metadata.py +99 -0
- spatialflow/_generated/spatialflow_generated/models/unsubscribe_request.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/unsubscribe_response.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/update_geofence_request.py +142 -0
- spatialflow/_generated/spatialflow_generated/models/update_integration_schema.py +121 -0
- spatialflow/_generated/spatialflow_generated/models/update_member_role_request.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/update_onboarding_progress_request.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/update_profile_request.py +208 -0
- spatialflow/_generated/spatialflow_generated/models/update_user_workspace_request.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/update_webhook_request.py +186 -0
- spatialflow/_generated/spatialflow_generated/models/upload_geofences_request.py +95 -0
- spatialflow/_generated/spatialflow_generated/models/upload_job_status.py +137 -0
- spatialflow/_generated/spatialflow_generated/models/usage_metrics.py +93 -0
- spatialflow/_generated/spatialflow_generated/models/usage_response.py +105 -0
- spatialflow/_generated/spatialflow_generated/models/usage_stats.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/user_action_response.py +119 -0
- spatialflow/_generated/spatialflow_generated/models/user_approval_request.py +92 -0
- spatialflow/_generated/spatialflow_generated/models/user_invite_request.py +110 -0
- spatialflow/_generated/spatialflow_generated/models/user_invite_response.py +99 -0
- spatialflow/_generated/spatialflow_generated/models/user_list_response.py +110 -0
- spatialflow/_generated/spatialflow_generated/models/user_profile_response.py +158 -0
- spatialflow/_generated/spatialflow_generated/models/user_rejection_request.py +87 -0
- spatialflow/_generated/spatialflow_generated/models/user_response.py +142 -0
- spatialflow/_generated/spatialflow_generated/models/user_summary.py +140 -0
- spatialflow/_generated/spatialflow_generated/models/user_usage_response.py +152 -0
- spatialflow/_generated/spatialflow_generated/models/user_workspace_response.py +110 -0
- spatialflow/_generated/spatialflow_generated/models/webhook_delivery_detail_response.py +182 -0
- spatialflow/_generated/spatialflow_generated/models/webhook_delivery_list_response.py +97 -0
- spatialflow/_generated/spatialflow_generated/models/webhook_delivery_response.py +161 -0
- spatialflow/_generated/spatialflow_generated/models/webhook_list_response.py +97 -0
- spatialflow/_generated/spatialflow_generated/models/webhook_metrics_response.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/webhook_response.py +148 -0
- spatialflow/_generated/spatialflow_generated/models/webhook_test_response.py +114 -0
- spatialflow/_generated/spatialflow_generated/models/workflow_import_schema.py +89 -0
- spatialflow/_generated/spatialflow_generated/models/workflow_in.py +98 -0
- spatialflow/_generated/spatialflow_generated/models/workflow_list_out.py +118 -0
- spatialflow/_generated/spatialflow_generated/models/workflow_list_response.py +101 -0
- spatialflow/_generated/spatialflow_generated/models/workflow_out.py +129 -0
- spatialflow/_generated/spatialflow_generated/models/workflow_retry_policy_update_schema.py +109 -0
- spatialflow/_generated/spatialflow_generated/models/workflow_step_retry_schema.py +103 -0
- spatialflow/_generated/spatialflow_generated/models/workflow_update.py +120 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_delete_response.py +93 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_detail.py +116 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_detail_response.py +143 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_in.py +122 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_list_item.py +130 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_list_response.py +103 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_members_response.py +109 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_out.py +132 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_summary.py +91 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_update_request.py +120 -0
- spatialflow/_generated/spatialflow_generated/models/workspace_update_response.py +93 -0
- spatialflow/_generated/spatialflow_generated/py.typed +0 -0
- spatialflow/_generated/spatialflow_generated/rest.py +215 -0
- spatialflow/_generated/test-requirements.txt +6 -0
- spatialflow/_generated/tox.ini +9 -0
- spatialflow/client.py +137 -0
- spatialflow/exceptions.py +234 -0
- spatialflow/jobs.py +204 -0
- spatialflow/pagination.py +142 -0
- spatialflow/uploads.py +166 -0
- spatialflow/webhooks.py +126 -0
- spatialflow-0.1.0.dist-info/METADATA +249 -0
- spatialflow-0.1.0.dist-info/RECORD +404 -0
- spatialflow-0.1.0.dist-info/WHEEL +4 -0
|
@@ -0,0 +1,1384 @@
|
|
|
1
|
+
# spatialflow_generated.WebhooksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spatialflow.io*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**apps_webhooks_api_create_webhook**](WebhooksApi.md#apps_webhooks_api_create_webhook) | **POST** /api/v1/webhooks/ | Create Webhook
|
|
8
|
+
[**apps_webhooks_api_delete_webhook**](WebhooksApi.md#apps_webhooks_api_delete_webhook) | **DELETE** /api/v1/webhooks/{webhook_id} | Delete Webhook
|
|
9
|
+
[**apps_webhooks_api_get_dlq_stats**](WebhooksApi.md#apps_webhooks_api_get_dlq_stats) | **GET** /api/v1/webhooks/dlq/stats | Get Dlq Stats
|
|
10
|
+
[**apps_webhooks_api_get_webhook**](WebhooksApi.md#apps_webhooks_api_get_webhook) | **GET** /api/v1/webhooks/{webhook_id} | Get Webhook
|
|
11
|
+
[**apps_webhooks_api_get_webhook_deliveries**](WebhooksApi.md#apps_webhooks_api_get_webhook_deliveries) | **GET** /api/v1/webhooks/{webhook_id}/deliveries | Get Webhook Deliveries
|
|
12
|
+
[**apps_webhooks_api_get_webhook_delivery_detail**](WebhooksApi.md#apps_webhooks_api_get_webhook_delivery_detail) | **GET** /api/v1/webhooks/{webhook_id}/deliveries/{delivery_id} | Get Webhook Delivery Detail
|
|
13
|
+
[**apps_webhooks_api_get_webhook_metrics**](WebhooksApi.md#apps_webhooks_api_get_webhook_metrics) | **GET** /api/v1/webhooks/metrics | Get Webhook Metrics
|
|
14
|
+
[**apps_webhooks_api_get_webhook_success_timeline**](WebhooksApi.md#apps_webhooks_api_get_webhook_success_timeline) | **GET** /api/v1/webhooks/success-timeline | Get Webhook Success Timeline
|
|
15
|
+
[**apps_webhooks_api_list_dlq_entries**](WebhooksApi.md#apps_webhooks_api_list_dlq_entries) | **GET** /api/v1/webhooks/dlq | List Dlq Entries
|
|
16
|
+
[**apps_webhooks_api_list_webhooks**](WebhooksApi.md#apps_webhooks_api_list_webhooks) | **GET** /api/v1/webhooks/ | List Webhooks
|
|
17
|
+
[**apps_webhooks_api_receive_webhook**](WebhooksApi.md#apps_webhooks_api_receive_webhook) | **POST** /api/v1/webhooks/receive/{webhook_id} | Receive Webhook
|
|
18
|
+
[**apps_webhooks_api_retry_from_dlq**](WebhooksApi.md#apps_webhooks_api_retry_from_dlq) | **POST** /api/v1/webhooks/dlq/{dlq_id}/retry | Retry From Dlq
|
|
19
|
+
[**apps_webhooks_api_retry_webhook_delivery**](WebhooksApi.md#apps_webhooks_api_retry_webhook_delivery) | **POST** /api/v1/webhooks/{webhook_id}/deliveries/{delivery_id}/retry | Retry Webhook Delivery
|
|
20
|
+
[**apps_webhooks_api_test_webhook**](WebhooksApi.md#apps_webhooks_api_test_webhook) | **POST** /api/v1/webhooks/{webhook_id}/test | Test Webhook
|
|
21
|
+
[**apps_webhooks_api_update_webhook**](WebhooksApi.md#apps_webhooks_api_update_webhook) | **PUT** /api/v1/webhooks/{webhook_id} | Update Webhook
|
|
22
|
+
[**apps_webhooks_api_webhook_health_check**](WebhooksApi.md#apps_webhooks_api_webhook_health_check) | **GET** /api/v1/webhooks/health | Webhook Health Check
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
# **apps_webhooks_api_create_webhook**
|
|
26
|
+
> WebhookResponse apps_webhooks_api_create_webhook(create_webhook_request)
|
|
27
|
+
|
|
28
|
+
Create Webhook
|
|
29
|
+
|
|
30
|
+
Create a new webhook endpoint.
|
|
31
|
+
|
|
32
|
+
### Example
|
|
33
|
+
|
|
34
|
+
* Api Key Authentication (APIKeyBearer):
|
|
35
|
+
* Bearer Authentication (JWTBearer):
|
|
36
|
+
|
|
37
|
+
```python
|
|
38
|
+
import spatialflow_generated
|
|
39
|
+
from spatialflow_generated.models.create_webhook_request import CreateWebhookRequest
|
|
40
|
+
from spatialflow_generated.models.webhook_response import WebhookResponse
|
|
41
|
+
from spatialflow_generated.rest import ApiException
|
|
42
|
+
from pprint import pprint
|
|
43
|
+
|
|
44
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
45
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
46
|
+
configuration = spatialflow_generated.Configuration(
|
|
47
|
+
host = "https://api.spatialflow.io"
|
|
48
|
+
)
|
|
49
|
+
|
|
50
|
+
# The client must configure the authentication and authorization parameters
|
|
51
|
+
# in accordance with the API server security policy.
|
|
52
|
+
# Examples for each auth method are provided below, use the example that
|
|
53
|
+
# satisfies your auth use case.
|
|
54
|
+
|
|
55
|
+
# Configure API key authorization: APIKeyBearer
|
|
56
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
57
|
+
|
|
58
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
59
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
60
|
+
|
|
61
|
+
# Configure Bearer authorization: JWTBearer
|
|
62
|
+
configuration = spatialflow_generated.Configuration(
|
|
63
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
64
|
+
)
|
|
65
|
+
|
|
66
|
+
# Enter a context with an instance of the API client
|
|
67
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
68
|
+
# Create an instance of the API class
|
|
69
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
70
|
+
create_webhook_request = spatialflow_generated.CreateWebhookRequest() # CreateWebhookRequest |
|
|
71
|
+
|
|
72
|
+
try:
|
|
73
|
+
# Create Webhook
|
|
74
|
+
api_response = await api_instance.apps_webhooks_api_create_webhook(create_webhook_request)
|
|
75
|
+
print("The response of WebhooksApi->apps_webhooks_api_create_webhook:\n")
|
|
76
|
+
pprint(api_response)
|
|
77
|
+
except Exception as e:
|
|
78
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_create_webhook: %s\n" % e)
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
Name | Type | Description | Notes
|
|
87
|
+
------------- | ------------- | ------------- | -------------
|
|
88
|
+
**create_webhook_request** | [**CreateWebhookRequest**](CreateWebhookRequest.md)| |
|
|
89
|
+
|
|
90
|
+
### Return type
|
|
91
|
+
|
|
92
|
+
[**WebhookResponse**](WebhookResponse.md)
|
|
93
|
+
|
|
94
|
+
### Authorization
|
|
95
|
+
|
|
96
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
97
|
+
|
|
98
|
+
### HTTP request headers
|
|
99
|
+
|
|
100
|
+
- **Content-Type**: application/json
|
|
101
|
+
- **Accept**: application/json
|
|
102
|
+
|
|
103
|
+
### HTTP response details
|
|
104
|
+
|
|
105
|
+
| Status code | Description | Response headers |
|
|
106
|
+
|-------------|-------------|------------------|
|
|
107
|
+
**201** | Created | - |
|
|
108
|
+
**400** | Bad Request | - |
|
|
109
|
+
**401** | Unauthorized | - |
|
|
110
|
+
**429** | Too Many Requests | - |
|
|
111
|
+
**500** | Internal Server Error | - |
|
|
112
|
+
|
|
113
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
114
|
+
|
|
115
|
+
# **apps_webhooks_api_delete_webhook**
|
|
116
|
+
> SuccessResponse apps_webhooks_api_delete_webhook(webhook_id)
|
|
117
|
+
|
|
118
|
+
Delete Webhook
|
|
119
|
+
|
|
120
|
+
Delete a webhook.
|
|
121
|
+
|
|
122
|
+
### Example
|
|
123
|
+
|
|
124
|
+
* Api Key Authentication (APIKeyBearer):
|
|
125
|
+
* Bearer Authentication (JWTBearer):
|
|
126
|
+
|
|
127
|
+
```python
|
|
128
|
+
import spatialflow_generated
|
|
129
|
+
from spatialflow_generated.models.success_response import SuccessResponse
|
|
130
|
+
from spatialflow_generated.rest import ApiException
|
|
131
|
+
from pprint import pprint
|
|
132
|
+
|
|
133
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
134
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
135
|
+
configuration = spatialflow_generated.Configuration(
|
|
136
|
+
host = "https://api.spatialflow.io"
|
|
137
|
+
)
|
|
138
|
+
|
|
139
|
+
# The client must configure the authentication and authorization parameters
|
|
140
|
+
# in accordance with the API server security policy.
|
|
141
|
+
# Examples for each auth method are provided below, use the example that
|
|
142
|
+
# satisfies your auth use case.
|
|
143
|
+
|
|
144
|
+
# Configure API key authorization: APIKeyBearer
|
|
145
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
146
|
+
|
|
147
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
148
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
149
|
+
|
|
150
|
+
# Configure Bearer authorization: JWTBearer
|
|
151
|
+
configuration = spatialflow_generated.Configuration(
|
|
152
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
153
|
+
)
|
|
154
|
+
|
|
155
|
+
# Enter a context with an instance of the API client
|
|
156
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
157
|
+
# Create an instance of the API class
|
|
158
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
159
|
+
webhook_id = 'webhook_id_example' # str |
|
|
160
|
+
|
|
161
|
+
try:
|
|
162
|
+
# Delete Webhook
|
|
163
|
+
api_response = await api_instance.apps_webhooks_api_delete_webhook(webhook_id)
|
|
164
|
+
print("The response of WebhooksApi->apps_webhooks_api_delete_webhook:\n")
|
|
165
|
+
pprint(api_response)
|
|
166
|
+
except Exception as e:
|
|
167
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_delete_webhook: %s\n" % e)
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### Parameters
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
Name | Type | Description | Notes
|
|
176
|
+
------------- | ------------- | ------------- | -------------
|
|
177
|
+
**webhook_id** | **str**| |
|
|
178
|
+
|
|
179
|
+
### Return type
|
|
180
|
+
|
|
181
|
+
[**SuccessResponse**](SuccessResponse.md)
|
|
182
|
+
|
|
183
|
+
### Authorization
|
|
184
|
+
|
|
185
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
186
|
+
|
|
187
|
+
### HTTP request headers
|
|
188
|
+
|
|
189
|
+
- **Content-Type**: Not defined
|
|
190
|
+
- **Accept**: application/json
|
|
191
|
+
|
|
192
|
+
### HTTP response details
|
|
193
|
+
|
|
194
|
+
| Status code | Description | Response headers |
|
|
195
|
+
|-------------|-------------|------------------|
|
|
196
|
+
**200** | OK | - |
|
|
197
|
+
**400** | Bad Request | - |
|
|
198
|
+
**401** | Unauthorized | - |
|
|
199
|
+
**404** | Not Found | - |
|
|
200
|
+
|
|
201
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
202
|
+
|
|
203
|
+
# **apps_webhooks_api_get_dlq_stats**
|
|
204
|
+
> Dict[str, object] apps_webhooks_api_get_dlq_stats()
|
|
205
|
+
|
|
206
|
+
Get Dlq Stats
|
|
207
|
+
|
|
208
|
+
Get Dead Letter Queue statistics for the workspace. Returns aggregated metrics about failed webhook deliveries including total entries, requeued count, and breakdown by webhook. Returns: 200: DLQ statistics 401: Unauthorized - invalid or missing authentication Example: GET /api/v1/webhooks/dlq/stats
|
|
209
|
+
|
|
210
|
+
### Example
|
|
211
|
+
|
|
212
|
+
* Bearer Authentication (JWTBearer):
|
|
213
|
+
|
|
214
|
+
```python
|
|
215
|
+
import spatialflow_generated
|
|
216
|
+
from spatialflow_generated.rest import ApiException
|
|
217
|
+
from pprint import pprint
|
|
218
|
+
|
|
219
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
220
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
221
|
+
configuration = spatialflow_generated.Configuration(
|
|
222
|
+
host = "https://api.spatialflow.io"
|
|
223
|
+
)
|
|
224
|
+
|
|
225
|
+
# The client must configure the authentication and authorization parameters
|
|
226
|
+
# in accordance with the API server security policy.
|
|
227
|
+
# Examples for each auth method are provided below, use the example that
|
|
228
|
+
# satisfies your auth use case.
|
|
229
|
+
|
|
230
|
+
# Configure Bearer authorization: JWTBearer
|
|
231
|
+
configuration = spatialflow_generated.Configuration(
|
|
232
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
233
|
+
)
|
|
234
|
+
|
|
235
|
+
# Enter a context with an instance of the API client
|
|
236
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
237
|
+
# Create an instance of the API class
|
|
238
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
239
|
+
|
|
240
|
+
try:
|
|
241
|
+
# Get Dlq Stats
|
|
242
|
+
api_response = await api_instance.apps_webhooks_api_get_dlq_stats()
|
|
243
|
+
print("The response of WebhooksApi->apps_webhooks_api_get_dlq_stats:\n")
|
|
244
|
+
pprint(api_response)
|
|
245
|
+
except Exception as e:
|
|
246
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_get_dlq_stats: %s\n" % e)
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
### Parameters
|
|
252
|
+
|
|
253
|
+
This endpoint does not need any parameter.
|
|
254
|
+
|
|
255
|
+
### Return type
|
|
256
|
+
|
|
257
|
+
**Dict[str, object]**
|
|
258
|
+
|
|
259
|
+
### Authorization
|
|
260
|
+
|
|
261
|
+
[JWTBearer](../README.md#JWTBearer)
|
|
262
|
+
|
|
263
|
+
### HTTP request headers
|
|
264
|
+
|
|
265
|
+
- **Content-Type**: Not defined
|
|
266
|
+
- **Accept**: application/json
|
|
267
|
+
|
|
268
|
+
### HTTP response details
|
|
269
|
+
|
|
270
|
+
| Status code | Description | Response headers |
|
|
271
|
+
|-------------|-------------|------------------|
|
|
272
|
+
**200** | OK | - |
|
|
273
|
+
**401** | Unauthorized | - |
|
|
274
|
+
|
|
275
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
276
|
+
|
|
277
|
+
# **apps_webhooks_api_get_webhook**
|
|
278
|
+
> WebhookResponse apps_webhooks_api_get_webhook(webhook_id)
|
|
279
|
+
|
|
280
|
+
Get Webhook
|
|
281
|
+
|
|
282
|
+
Get a specific webhook by ID.
|
|
283
|
+
|
|
284
|
+
### Example
|
|
285
|
+
|
|
286
|
+
* Api Key Authentication (APIKeyBearer):
|
|
287
|
+
* Bearer Authentication (JWTBearer):
|
|
288
|
+
|
|
289
|
+
```python
|
|
290
|
+
import spatialflow_generated
|
|
291
|
+
from spatialflow_generated.models.webhook_response import WebhookResponse
|
|
292
|
+
from spatialflow_generated.rest import ApiException
|
|
293
|
+
from pprint import pprint
|
|
294
|
+
|
|
295
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
296
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
297
|
+
configuration = spatialflow_generated.Configuration(
|
|
298
|
+
host = "https://api.spatialflow.io"
|
|
299
|
+
)
|
|
300
|
+
|
|
301
|
+
# The client must configure the authentication and authorization parameters
|
|
302
|
+
# in accordance with the API server security policy.
|
|
303
|
+
# Examples for each auth method are provided below, use the example that
|
|
304
|
+
# satisfies your auth use case.
|
|
305
|
+
|
|
306
|
+
# Configure API key authorization: APIKeyBearer
|
|
307
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
308
|
+
|
|
309
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
310
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
311
|
+
|
|
312
|
+
# Configure Bearer authorization: JWTBearer
|
|
313
|
+
configuration = spatialflow_generated.Configuration(
|
|
314
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
315
|
+
)
|
|
316
|
+
|
|
317
|
+
# Enter a context with an instance of the API client
|
|
318
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
319
|
+
# Create an instance of the API class
|
|
320
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
321
|
+
webhook_id = 'webhook_id_example' # str |
|
|
322
|
+
|
|
323
|
+
try:
|
|
324
|
+
# Get Webhook
|
|
325
|
+
api_response = await api_instance.apps_webhooks_api_get_webhook(webhook_id)
|
|
326
|
+
print("The response of WebhooksApi->apps_webhooks_api_get_webhook:\n")
|
|
327
|
+
pprint(api_response)
|
|
328
|
+
except Exception as e:
|
|
329
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_get_webhook: %s\n" % e)
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
### Parameters
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
Name | Type | Description | Notes
|
|
338
|
+
------------- | ------------- | ------------- | -------------
|
|
339
|
+
**webhook_id** | **str**| |
|
|
340
|
+
|
|
341
|
+
### Return type
|
|
342
|
+
|
|
343
|
+
[**WebhookResponse**](WebhookResponse.md)
|
|
344
|
+
|
|
345
|
+
### Authorization
|
|
346
|
+
|
|
347
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
348
|
+
|
|
349
|
+
### HTTP request headers
|
|
350
|
+
|
|
351
|
+
- **Content-Type**: Not defined
|
|
352
|
+
- **Accept**: application/json
|
|
353
|
+
|
|
354
|
+
### HTTP response details
|
|
355
|
+
|
|
356
|
+
| Status code | Description | Response headers |
|
|
357
|
+
|-------------|-------------|------------------|
|
|
358
|
+
**200** | OK | - |
|
|
359
|
+
**401** | Unauthorized | - |
|
|
360
|
+
**404** | Not Found | - |
|
|
361
|
+
|
|
362
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
363
|
+
|
|
364
|
+
# **apps_webhooks_api_get_webhook_deliveries**
|
|
365
|
+
> WebhookDeliveryListResponse apps_webhooks_api_get_webhook_deliveries(webhook_id, limit=limit, offset=offset, status=status, event_type=event_type)
|
|
366
|
+
|
|
367
|
+
Get Webhook Deliveries
|
|
368
|
+
|
|
369
|
+
Get delivery history for a webhook.
|
|
370
|
+
|
|
371
|
+
### Example
|
|
372
|
+
|
|
373
|
+
* Api Key Authentication (APIKeyBearer):
|
|
374
|
+
* Bearer Authentication (JWTBearer):
|
|
375
|
+
|
|
376
|
+
```python
|
|
377
|
+
import spatialflow_generated
|
|
378
|
+
from spatialflow_generated.models.webhook_delivery_list_response import WebhookDeliveryListResponse
|
|
379
|
+
from spatialflow_generated.rest import ApiException
|
|
380
|
+
from pprint import pprint
|
|
381
|
+
|
|
382
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
383
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
384
|
+
configuration = spatialflow_generated.Configuration(
|
|
385
|
+
host = "https://api.spatialflow.io"
|
|
386
|
+
)
|
|
387
|
+
|
|
388
|
+
# The client must configure the authentication and authorization parameters
|
|
389
|
+
# in accordance with the API server security policy.
|
|
390
|
+
# Examples for each auth method are provided below, use the example that
|
|
391
|
+
# satisfies your auth use case.
|
|
392
|
+
|
|
393
|
+
# Configure API key authorization: APIKeyBearer
|
|
394
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
395
|
+
|
|
396
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
397
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
398
|
+
|
|
399
|
+
# Configure Bearer authorization: JWTBearer
|
|
400
|
+
configuration = spatialflow_generated.Configuration(
|
|
401
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
402
|
+
)
|
|
403
|
+
|
|
404
|
+
# Enter a context with an instance of the API client
|
|
405
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
406
|
+
# Create an instance of the API class
|
|
407
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
408
|
+
webhook_id = 'webhook_id_example' # str |
|
|
409
|
+
limit = 50 # int | (optional) (default to 50)
|
|
410
|
+
offset = 0 # int | (optional) (default to 0)
|
|
411
|
+
status = 'status_example' # str | (optional)
|
|
412
|
+
event_type = 'event_type_example' # str | (optional)
|
|
413
|
+
|
|
414
|
+
try:
|
|
415
|
+
# Get Webhook Deliveries
|
|
416
|
+
api_response = await api_instance.apps_webhooks_api_get_webhook_deliveries(webhook_id, limit=limit, offset=offset, status=status, event_type=event_type)
|
|
417
|
+
print("The response of WebhooksApi->apps_webhooks_api_get_webhook_deliveries:\n")
|
|
418
|
+
pprint(api_response)
|
|
419
|
+
except Exception as e:
|
|
420
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_get_webhook_deliveries: %s\n" % e)
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
### Parameters
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
Name | Type | Description | Notes
|
|
429
|
+
------------- | ------------- | ------------- | -------------
|
|
430
|
+
**webhook_id** | **str**| |
|
|
431
|
+
**limit** | **int**| | [optional] [default to 50]
|
|
432
|
+
**offset** | **int**| | [optional] [default to 0]
|
|
433
|
+
**status** | **str**| | [optional]
|
|
434
|
+
**event_type** | **str**| | [optional]
|
|
435
|
+
|
|
436
|
+
### Return type
|
|
437
|
+
|
|
438
|
+
[**WebhookDeliveryListResponse**](WebhookDeliveryListResponse.md)
|
|
439
|
+
|
|
440
|
+
### Authorization
|
|
441
|
+
|
|
442
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
443
|
+
|
|
444
|
+
### HTTP request headers
|
|
445
|
+
|
|
446
|
+
- **Content-Type**: Not defined
|
|
447
|
+
- **Accept**: application/json
|
|
448
|
+
|
|
449
|
+
### HTTP response details
|
|
450
|
+
|
|
451
|
+
| Status code | Description | Response headers |
|
|
452
|
+
|-------------|-------------|------------------|
|
|
453
|
+
**200** | OK | - |
|
|
454
|
+
**401** | Unauthorized | - |
|
|
455
|
+
**404** | Not Found | - |
|
|
456
|
+
|
|
457
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
458
|
+
|
|
459
|
+
# **apps_webhooks_api_get_webhook_delivery_detail**
|
|
460
|
+
> WebhookDeliveryDetailResponse apps_webhooks_api_get_webhook_delivery_detail(webhook_id, delivery_id)
|
|
461
|
+
|
|
462
|
+
Get Webhook Delivery Detail
|
|
463
|
+
|
|
464
|
+
Get detailed delivery information.
|
|
465
|
+
|
|
466
|
+
### Example
|
|
467
|
+
|
|
468
|
+
* Api Key Authentication (APIKeyBearer):
|
|
469
|
+
* Bearer Authentication (JWTBearer):
|
|
470
|
+
|
|
471
|
+
```python
|
|
472
|
+
import spatialflow_generated
|
|
473
|
+
from spatialflow_generated.models.webhook_delivery_detail_response import WebhookDeliveryDetailResponse
|
|
474
|
+
from spatialflow_generated.rest import ApiException
|
|
475
|
+
from pprint import pprint
|
|
476
|
+
|
|
477
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
478
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
479
|
+
configuration = spatialflow_generated.Configuration(
|
|
480
|
+
host = "https://api.spatialflow.io"
|
|
481
|
+
)
|
|
482
|
+
|
|
483
|
+
# The client must configure the authentication and authorization parameters
|
|
484
|
+
# in accordance with the API server security policy.
|
|
485
|
+
# Examples for each auth method are provided below, use the example that
|
|
486
|
+
# satisfies your auth use case.
|
|
487
|
+
|
|
488
|
+
# Configure API key authorization: APIKeyBearer
|
|
489
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
490
|
+
|
|
491
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
492
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
493
|
+
|
|
494
|
+
# Configure Bearer authorization: JWTBearer
|
|
495
|
+
configuration = spatialflow_generated.Configuration(
|
|
496
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
497
|
+
)
|
|
498
|
+
|
|
499
|
+
# Enter a context with an instance of the API client
|
|
500
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
501
|
+
# Create an instance of the API class
|
|
502
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
503
|
+
webhook_id = 'webhook_id_example' # str |
|
|
504
|
+
delivery_id = 'delivery_id_example' # str |
|
|
505
|
+
|
|
506
|
+
try:
|
|
507
|
+
# Get Webhook Delivery Detail
|
|
508
|
+
api_response = await api_instance.apps_webhooks_api_get_webhook_delivery_detail(webhook_id, delivery_id)
|
|
509
|
+
print("The response of WebhooksApi->apps_webhooks_api_get_webhook_delivery_detail:\n")
|
|
510
|
+
pprint(api_response)
|
|
511
|
+
except Exception as e:
|
|
512
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_get_webhook_delivery_detail: %s\n" % e)
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
### Parameters
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
Name | Type | Description | Notes
|
|
521
|
+
------------- | ------------- | ------------- | -------------
|
|
522
|
+
**webhook_id** | **str**| |
|
|
523
|
+
**delivery_id** | **str**| |
|
|
524
|
+
|
|
525
|
+
### Return type
|
|
526
|
+
|
|
527
|
+
[**WebhookDeliveryDetailResponse**](WebhookDeliveryDetailResponse.md)
|
|
528
|
+
|
|
529
|
+
### Authorization
|
|
530
|
+
|
|
531
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
532
|
+
|
|
533
|
+
### HTTP request headers
|
|
534
|
+
|
|
535
|
+
- **Content-Type**: Not defined
|
|
536
|
+
- **Accept**: application/json
|
|
537
|
+
|
|
538
|
+
### HTTP response details
|
|
539
|
+
|
|
540
|
+
| Status code | Description | Response headers |
|
|
541
|
+
|-------------|-------------|------------------|
|
|
542
|
+
**200** | OK | - |
|
|
543
|
+
**401** | Unauthorized | - |
|
|
544
|
+
**404** | Not Found | - |
|
|
545
|
+
**500** | Internal Server Error | - |
|
|
546
|
+
|
|
547
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
548
|
+
|
|
549
|
+
# **apps_webhooks_api_get_webhook_metrics**
|
|
550
|
+
> WebhookMetricsResponse apps_webhooks_api_get_webhook_metrics()
|
|
551
|
+
|
|
552
|
+
Get Webhook Metrics
|
|
553
|
+
|
|
554
|
+
Get current webhook delivery metrics (admin only).
|
|
555
|
+
|
|
556
|
+
### Example
|
|
557
|
+
|
|
558
|
+
* Api Key Authentication (APIKeyBearer):
|
|
559
|
+
* Bearer Authentication (JWTBearer):
|
|
560
|
+
|
|
561
|
+
```python
|
|
562
|
+
import spatialflow_generated
|
|
563
|
+
from spatialflow_generated.models.webhook_metrics_response import WebhookMetricsResponse
|
|
564
|
+
from spatialflow_generated.rest import ApiException
|
|
565
|
+
from pprint import pprint
|
|
566
|
+
|
|
567
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
568
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
569
|
+
configuration = spatialflow_generated.Configuration(
|
|
570
|
+
host = "https://api.spatialflow.io"
|
|
571
|
+
)
|
|
572
|
+
|
|
573
|
+
# The client must configure the authentication and authorization parameters
|
|
574
|
+
# in accordance with the API server security policy.
|
|
575
|
+
# Examples for each auth method are provided below, use the example that
|
|
576
|
+
# satisfies your auth use case.
|
|
577
|
+
|
|
578
|
+
# Configure API key authorization: APIKeyBearer
|
|
579
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
580
|
+
|
|
581
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
582
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
583
|
+
|
|
584
|
+
# Configure Bearer authorization: JWTBearer
|
|
585
|
+
configuration = spatialflow_generated.Configuration(
|
|
586
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
587
|
+
)
|
|
588
|
+
|
|
589
|
+
# Enter a context with an instance of the API client
|
|
590
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
591
|
+
# Create an instance of the API class
|
|
592
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
593
|
+
|
|
594
|
+
try:
|
|
595
|
+
# Get Webhook Metrics
|
|
596
|
+
api_response = await api_instance.apps_webhooks_api_get_webhook_metrics()
|
|
597
|
+
print("The response of WebhooksApi->apps_webhooks_api_get_webhook_metrics:\n")
|
|
598
|
+
pprint(api_response)
|
|
599
|
+
except Exception as e:
|
|
600
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_get_webhook_metrics: %s\n" % e)
|
|
601
|
+
```
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
### Parameters
|
|
606
|
+
|
|
607
|
+
This endpoint does not need any parameter.
|
|
608
|
+
|
|
609
|
+
### Return type
|
|
610
|
+
|
|
611
|
+
[**WebhookMetricsResponse**](WebhookMetricsResponse.md)
|
|
612
|
+
|
|
613
|
+
### Authorization
|
|
614
|
+
|
|
615
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
616
|
+
|
|
617
|
+
### HTTP request headers
|
|
618
|
+
|
|
619
|
+
- **Content-Type**: Not defined
|
|
620
|
+
- **Accept**: application/json
|
|
621
|
+
|
|
622
|
+
### HTTP response details
|
|
623
|
+
|
|
624
|
+
| Status code | Description | Response headers |
|
|
625
|
+
|-------------|-------------|------------------|
|
|
626
|
+
**200** | OK | - |
|
|
627
|
+
**401** | Unauthorized | - |
|
|
628
|
+
**403** | Forbidden | - |
|
|
629
|
+
**500** | Internal Server Error | - |
|
|
630
|
+
|
|
631
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
632
|
+
|
|
633
|
+
# **apps_webhooks_api_get_webhook_success_timeline**
|
|
634
|
+
> Dict[str, object] apps_webhooks_api_get_webhook_success_timeline(time_range=time_range, start_date=start_date, end_date=end_date)
|
|
635
|
+
|
|
636
|
+
Get Webhook Success Timeline
|
|
637
|
+
|
|
638
|
+
Get webhook delivery success rate timeline for sparkline visualization. Aggregates webhook delivery success rates over the specified time range, returning hourly or daily buckets depending on the range duration. Args: time_range: One of 'today', 'week', 'month', 'custom' (default: 'today') start_date: ISO date string for custom range start (YYYY-MM-DD) end_date: ISO date string for custom range end (YYYY-MM-DD) Returns: 200: Success rate timeline with current overall rate 401: Unauthorized - invalid or missing authentication Example: GET /api/v1/webhooks/success-timeline?time_range=week Response: { \"timeline\": [ {\"timestamp\": \"2025-10-01T00:00:00Z\", \"success_rate\": 95.2, \"total\": 100, \"successful\": 95}, ... ], \"current_rate\": 96.5, \"total_deliveries\": 1000, \"successful_deliveries\": 965 }
|
|
639
|
+
|
|
640
|
+
### Example
|
|
641
|
+
|
|
642
|
+
* Bearer Authentication (JWTBearer):
|
|
643
|
+
|
|
644
|
+
```python
|
|
645
|
+
import spatialflow_generated
|
|
646
|
+
from spatialflow_generated.rest import ApiException
|
|
647
|
+
from pprint import pprint
|
|
648
|
+
|
|
649
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
650
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
651
|
+
configuration = spatialflow_generated.Configuration(
|
|
652
|
+
host = "https://api.spatialflow.io"
|
|
653
|
+
)
|
|
654
|
+
|
|
655
|
+
# The client must configure the authentication and authorization parameters
|
|
656
|
+
# in accordance with the API server security policy.
|
|
657
|
+
# Examples for each auth method are provided below, use the example that
|
|
658
|
+
# satisfies your auth use case.
|
|
659
|
+
|
|
660
|
+
# Configure Bearer authorization: JWTBearer
|
|
661
|
+
configuration = spatialflow_generated.Configuration(
|
|
662
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
663
|
+
)
|
|
664
|
+
|
|
665
|
+
# Enter a context with an instance of the API client
|
|
666
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
667
|
+
# Create an instance of the API class
|
|
668
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
669
|
+
time_range = 'today' # str | (optional) (default to 'today')
|
|
670
|
+
start_date = 'start_date_example' # str | (optional)
|
|
671
|
+
end_date = 'end_date_example' # str | (optional)
|
|
672
|
+
|
|
673
|
+
try:
|
|
674
|
+
# Get Webhook Success Timeline
|
|
675
|
+
api_response = await api_instance.apps_webhooks_api_get_webhook_success_timeline(time_range=time_range, start_date=start_date, end_date=end_date)
|
|
676
|
+
print("The response of WebhooksApi->apps_webhooks_api_get_webhook_success_timeline:\n")
|
|
677
|
+
pprint(api_response)
|
|
678
|
+
except Exception as e:
|
|
679
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_get_webhook_success_timeline: %s\n" % e)
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
### Parameters
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
Name | Type | Description | Notes
|
|
688
|
+
------------- | ------------- | ------------- | -------------
|
|
689
|
+
**time_range** | **str**| | [optional] [default to 'today']
|
|
690
|
+
**start_date** | **str**| | [optional]
|
|
691
|
+
**end_date** | **str**| | [optional]
|
|
692
|
+
|
|
693
|
+
### Return type
|
|
694
|
+
|
|
695
|
+
**Dict[str, object]**
|
|
696
|
+
|
|
697
|
+
### Authorization
|
|
698
|
+
|
|
699
|
+
[JWTBearer](../README.md#JWTBearer)
|
|
700
|
+
|
|
701
|
+
### HTTP request headers
|
|
702
|
+
|
|
703
|
+
- **Content-Type**: Not defined
|
|
704
|
+
- **Accept**: application/json
|
|
705
|
+
|
|
706
|
+
### HTTP response details
|
|
707
|
+
|
|
708
|
+
| Status code | Description | Response headers |
|
|
709
|
+
|-------------|-------------|------------------|
|
|
710
|
+
**200** | OK | - |
|
|
711
|
+
**401** | Unauthorized | - |
|
|
712
|
+
|
|
713
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
714
|
+
|
|
715
|
+
# **apps_webhooks_api_list_dlq_entries**
|
|
716
|
+
> Dict[str, object] apps_webhooks_api_list_dlq_entries(limit=limit, offset=offset, requeued=requeued)
|
|
717
|
+
|
|
718
|
+
List Dlq Entries
|
|
719
|
+
|
|
720
|
+
List webhook deliveries in Dead Letter Queue. Returns failed webhook deliveries that have exhausted all retry attempts. Entries can be filtered by requeue status and are paginated for performance. Args: limit: Maximum number of entries to return (default: 50, max: 100) offset: Number of entries to skip for pagination (default: 0) requeued: Filter by requeue status (None = all, True = requeued only, False = not requeued) Returns: 200: List of DLQ entries with pagination metadata 401: Unauthorized - invalid or missing authentication Example: GET /api/v1/webhooks/dlq?limit=20&requeued=false
|
|
721
|
+
|
|
722
|
+
### Example
|
|
723
|
+
|
|
724
|
+
* Bearer Authentication (JWTBearer):
|
|
725
|
+
|
|
726
|
+
```python
|
|
727
|
+
import spatialflow_generated
|
|
728
|
+
from spatialflow_generated.rest import ApiException
|
|
729
|
+
from pprint import pprint
|
|
730
|
+
|
|
731
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
732
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
733
|
+
configuration = spatialflow_generated.Configuration(
|
|
734
|
+
host = "https://api.spatialflow.io"
|
|
735
|
+
)
|
|
736
|
+
|
|
737
|
+
# The client must configure the authentication and authorization parameters
|
|
738
|
+
# in accordance with the API server security policy.
|
|
739
|
+
# Examples for each auth method are provided below, use the example that
|
|
740
|
+
# satisfies your auth use case.
|
|
741
|
+
|
|
742
|
+
# Configure Bearer authorization: JWTBearer
|
|
743
|
+
configuration = spatialflow_generated.Configuration(
|
|
744
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
745
|
+
)
|
|
746
|
+
|
|
747
|
+
# Enter a context with an instance of the API client
|
|
748
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
749
|
+
# Create an instance of the API class
|
|
750
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
751
|
+
limit = 50 # int | (optional) (default to 50)
|
|
752
|
+
offset = 0 # int | (optional) (default to 0)
|
|
753
|
+
requeued = True # bool | (optional)
|
|
754
|
+
|
|
755
|
+
try:
|
|
756
|
+
# List Dlq Entries
|
|
757
|
+
api_response = await api_instance.apps_webhooks_api_list_dlq_entries(limit=limit, offset=offset, requeued=requeued)
|
|
758
|
+
print("The response of WebhooksApi->apps_webhooks_api_list_dlq_entries:\n")
|
|
759
|
+
pprint(api_response)
|
|
760
|
+
except Exception as e:
|
|
761
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_list_dlq_entries: %s\n" % e)
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
### Parameters
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
Name | Type | Description | Notes
|
|
770
|
+
------------- | ------------- | ------------- | -------------
|
|
771
|
+
**limit** | **int**| | [optional] [default to 50]
|
|
772
|
+
**offset** | **int**| | [optional] [default to 0]
|
|
773
|
+
**requeued** | **bool**| | [optional]
|
|
774
|
+
|
|
775
|
+
### Return type
|
|
776
|
+
|
|
777
|
+
**Dict[str, object]**
|
|
778
|
+
|
|
779
|
+
### Authorization
|
|
780
|
+
|
|
781
|
+
[JWTBearer](../README.md#JWTBearer)
|
|
782
|
+
|
|
783
|
+
### HTTP request headers
|
|
784
|
+
|
|
785
|
+
- **Content-Type**: Not defined
|
|
786
|
+
- **Accept**: application/json
|
|
787
|
+
|
|
788
|
+
### HTTP response details
|
|
789
|
+
|
|
790
|
+
| Status code | Description | Response headers |
|
|
791
|
+
|-------------|-------------|------------------|
|
|
792
|
+
**200** | OK | - |
|
|
793
|
+
**401** | Unauthorized | - |
|
|
794
|
+
|
|
795
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
796
|
+
|
|
797
|
+
# **apps_webhooks_api_list_webhooks**
|
|
798
|
+
> WebhookListResponse apps_webhooks_api_list_webhooks(limit=limit, offset=offset, is_active=is_active)
|
|
799
|
+
|
|
800
|
+
List Webhooks
|
|
801
|
+
|
|
802
|
+
List user's webhooks with pagination.
|
|
803
|
+
|
|
804
|
+
### Example
|
|
805
|
+
|
|
806
|
+
* Api Key Authentication (APIKeyBearer):
|
|
807
|
+
* Bearer Authentication (JWTBearer):
|
|
808
|
+
|
|
809
|
+
```python
|
|
810
|
+
import spatialflow_generated
|
|
811
|
+
from spatialflow_generated.models.webhook_list_response import WebhookListResponse
|
|
812
|
+
from spatialflow_generated.rest import ApiException
|
|
813
|
+
from pprint import pprint
|
|
814
|
+
|
|
815
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
816
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
817
|
+
configuration = spatialflow_generated.Configuration(
|
|
818
|
+
host = "https://api.spatialflow.io"
|
|
819
|
+
)
|
|
820
|
+
|
|
821
|
+
# The client must configure the authentication and authorization parameters
|
|
822
|
+
# in accordance with the API server security policy.
|
|
823
|
+
# Examples for each auth method are provided below, use the example that
|
|
824
|
+
# satisfies your auth use case.
|
|
825
|
+
|
|
826
|
+
# Configure API key authorization: APIKeyBearer
|
|
827
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
828
|
+
|
|
829
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
830
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
831
|
+
|
|
832
|
+
# Configure Bearer authorization: JWTBearer
|
|
833
|
+
configuration = spatialflow_generated.Configuration(
|
|
834
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
835
|
+
)
|
|
836
|
+
|
|
837
|
+
# Enter a context with an instance of the API client
|
|
838
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
839
|
+
# Create an instance of the API class
|
|
840
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
841
|
+
limit = 50 # int | (optional) (default to 50)
|
|
842
|
+
offset = 0 # int | (optional) (default to 0)
|
|
843
|
+
is_active = True # bool | (optional)
|
|
844
|
+
|
|
845
|
+
try:
|
|
846
|
+
# List Webhooks
|
|
847
|
+
api_response = await api_instance.apps_webhooks_api_list_webhooks(limit=limit, offset=offset, is_active=is_active)
|
|
848
|
+
print("The response of WebhooksApi->apps_webhooks_api_list_webhooks:\n")
|
|
849
|
+
pprint(api_response)
|
|
850
|
+
except Exception as e:
|
|
851
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_list_webhooks: %s\n" % e)
|
|
852
|
+
```
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
### Parameters
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
Name | Type | Description | Notes
|
|
860
|
+
------------- | ------------- | ------------- | -------------
|
|
861
|
+
**limit** | **int**| | [optional] [default to 50]
|
|
862
|
+
**offset** | **int**| | [optional] [default to 0]
|
|
863
|
+
**is_active** | **bool**| | [optional]
|
|
864
|
+
|
|
865
|
+
### Return type
|
|
866
|
+
|
|
867
|
+
[**WebhookListResponse**](WebhookListResponse.md)
|
|
868
|
+
|
|
869
|
+
### Authorization
|
|
870
|
+
|
|
871
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
872
|
+
|
|
873
|
+
### HTTP request headers
|
|
874
|
+
|
|
875
|
+
- **Content-Type**: Not defined
|
|
876
|
+
- **Accept**: application/json
|
|
877
|
+
|
|
878
|
+
### HTTP response details
|
|
879
|
+
|
|
880
|
+
| Status code | Description | Response headers |
|
|
881
|
+
|-------------|-------------|------------------|
|
|
882
|
+
**200** | OK | - |
|
|
883
|
+
**401** | Unauthorized | - |
|
|
884
|
+
**429** | Too Many Requests | - |
|
|
885
|
+
|
|
886
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
887
|
+
|
|
888
|
+
# **apps_webhooks_api_receive_webhook**
|
|
889
|
+
> SuccessResponse apps_webhooks_api_receive_webhook(webhook_id)
|
|
890
|
+
|
|
891
|
+
Receive Webhook
|
|
892
|
+
|
|
893
|
+
Receive incoming webhook from external service with signature verification. This endpoint is PUBLIC and used when SpatialFlow receives webhooks from external services (e.g., payment providers, third-party integrations). The signature is verified using the configured secret for the webhook. Security: This endpoint does not require authentication since external services cannot authenticate with our org context. Security is provided by signature validation.
|
|
894
|
+
|
|
895
|
+
### Example
|
|
896
|
+
|
|
897
|
+
* Bearer Authentication (JWTBearer):
|
|
898
|
+
|
|
899
|
+
```python
|
|
900
|
+
import spatialflow_generated
|
|
901
|
+
from spatialflow_generated.models.success_response import SuccessResponse
|
|
902
|
+
from spatialflow_generated.rest import ApiException
|
|
903
|
+
from pprint import pprint
|
|
904
|
+
|
|
905
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
906
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
907
|
+
configuration = spatialflow_generated.Configuration(
|
|
908
|
+
host = "https://api.spatialflow.io"
|
|
909
|
+
)
|
|
910
|
+
|
|
911
|
+
# The client must configure the authentication and authorization parameters
|
|
912
|
+
# in accordance with the API server security policy.
|
|
913
|
+
# Examples for each auth method are provided below, use the example that
|
|
914
|
+
# satisfies your auth use case.
|
|
915
|
+
|
|
916
|
+
# Configure Bearer authorization: JWTBearer
|
|
917
|
+
configuration = spatialflow_generated.Configuration(
|
|
918
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
919
|
+
)
|
|
920
|
+
|
|
921
|
+
# Enter a context with an instance of the API client
|
|
922
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
923
|
+
# Create an instance of the API class
|
|
924
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
925
|
+
webhook_id = 'webhook_id_example' # str |
|
|
926
|
+
|
|
927
|
+
try:
|
|
928
|
+
# Receive Webhook
|
|
929
|
+
api_response = await api_instance.apps_webhooks_api_receive_webhook(webhook_id)
|
|
930
|
+
print("The response of WebhooksApi->apps_webhooks_api_receive_webhook:\n")
|
|
931
|
+
pprint(api_response)
|
|
932
|
+
except Exception as e:
|
|
933
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_receive_webhook: %s\n" % e)
|
|
934
|
+
```
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
### Parameters
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
Name | Type | Description | Notes
|
|
942
|
+
------------- | ------------- | ------------- | -------------
|
|
943
|
+
**webhook_id** | **str**| |
|
|
944
|
+
|
|
945
|
+
### Return type
|
|
946
|
+
|
|
947
|
+
[**SuccessResponse**](SuccessResponse.md)
|
|
948
|
+
|
|
949
|
+
### Authorization
|
|
950
|
+
|
|
951
|
+
[JWTBearer](../README.md#JWTBearer)
|
|
952
|
+
|
|
953
|
+
### HTTP request headers
|
|
954
|
+
|
|
955
|
+
- **Content-Type**: Not defined
|
|
956
|
+
- **Accept**: application/json
|
|
957
|
+
|
|
958
|
+
### HTTP response details
|
|
959
|
+
|
|
960
|
+
| Status code | Description | Response headers |
|
|
961
|
+
|-------------|-------------|------------------|
|
|
962
|
+
**200** | OK | - |
|
|
963
|
+
**401** | Unauthorized | - |
|
|
964
|
+
**404** | Not Found | - |
|
|
965
|
+
|
|
966
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
967
|
+
|
|
968
|
+
# **apps_webhooks_api_retry_from_dlq**
|
|
969
|
+
> Dict[str, object] apps_webhooks_api_retry_from_dlq(dlq_id)
|
|
970
|
+
|
|
971
|
+
Retry From Dlq
|
|
972
|
+
|
|
973
|
+
Manually retry a failed webhook delivery from Dead Letter Queue. Marks the DLQ entry as requeued and creates a new delivery attempt. The webhook will go through the full retry logic again (7 attempts). Args: dlq_id: UUID of the DLQ entry to retry Returns: 200: Successfully queued for retry with new task ID 400: Entry already requeued 401: Unauthorized - invalid or missing authentication 404: DLQ entry not found or doesn't belong to workspace Example: POST /api/v1/webhooks/dlq/550e8400-e29b-41d4-a716-446655440000/retry
|
|
974
|
+
|
|
975
|
+
### Example
|
|
976
|
+
|
|
977
|
+
* Bearer Authentication (JWTBearer):
|
|
978
|
+
|
|
979
|
+
```python
|
|
980
|
+
import spatialflow_generated
|
|
981
|
+
from spatialflow_generated.rest import ApiException
|
|
982
|
+
from pprint import pprint
|
|
983
|
+
|
|
984
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
985
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
986
|
+
configuration = spatialflow_generated.Configuration(
|
|
987
|
+
host = "https://api.spatialflow.io"
|
|
988
|
+
)
|
|
989
|
+
|
|
990
|
+
# The client must configure the authentication and authorization parameters
|
|
991
|
+
# in accordance with the API server security policy.
|
|
992
|
+
# Examples for each auth method are provided below, use the example that
|
|
993
|
+
# satisfies your auth use case.
|
|
994
|
+
|
|
995
|
+
# Configure Bearer authorization: JWTBearer
|
|
996
|
+
configuration = spatialflow_generated.Configuration(
|
|
997
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
998
|
+
)
|
|
999
|
+
|
|
1000
|
+
# Enter a context with an instance of the API client
|
|
1001
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1002
|
+
# Create an instance of the API class
|
|
1003
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
1004
|
+
dlq_id = 'dlq_id_example' # str |
|
|
1005
|
+
|
|
1006
|
+
try:
|
|
1007
|
+
# Retry From Dlq
|
|
1008
|
+
api_response = await api_instance.apps_webhooks_api_retry_from_dlq(dlq_id)
|
|
1009
|
+
print("The response of WebhooksApi->apps_webhooks_api_retry_from_dlq:\n")
|
|
1010
|
+
pprint(api_response)
|
|
1011
|
+
except Exception as e:
|
|
1012
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_retry_from_dlq: %s\n" % e)
|
|
1013
|
+
```
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
### Parameters
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
Name | Type | Description | Notes
|
|
1021
|
+
------------- | ------------- | ------------- | -------------
|
|
1022
|
+
**dlq_id** | **str**| |
|
|
1023
|
+
|
|
1024
|
+
### Return type
|
|
1025
|
+
|
|
1026
|
+
**Dict[str, object]**
|
|
1027
|
+
|
|
1028
|
+
### Authorization
|
|
1029
|
+
|
|
1030
|
+
[JWTBearer](../README.md#JWTBearer)
|
|
1031
|
+
|
|
1032
|
+
### HTTP request headers
|
|
1033
|
+
|
|
1034
|
+
- **Content-Type**: Not defined
|
|
1035
|
+
- **Accept**: application/json
|
|
1036
|
+
|
|
1037
|
+
### HTTP response details
|
|
1038
|
+
|
|
1039
|
+
| Status code | Description | Response headers |
|
|
1040
|
+
|-------------|-------------|------------------|
|
|
1041
|
+
**200** | OK | - |
|
|
1042
|
+
**400** | Bad Request | - |
|
|
1043
|
+
**401** | Unauthorized | - |
|
|
1044
|
+
**404** | Not Found | - |
|
|
1045
|
+
|
|
1046
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1047
|
+
|
|
1048
|
+
# **apps_webhooks_api_retry_webhook_delivery**
|
|
1049
|
+
> Dict[str, object] apps_webhooks_api_retry_webhook_delivery(webhook_id, delivery_id)
|
|
1050
|
+
|
|
1051
|
+
Retry Webhook Delivery
|
|
1052
|
+
|
|
1053
|
+
Retry a failed webhook delivery.
|
|
1054
|
+
|
|
1055
|
+
### Example
|
|
1056
|
+
|
|
1057
|
+
* Api Key Authentication (APIKeyBearer):
|
|
1058
|
+
* Bearer Authentication (JWTBearer):
|
|
1059
|
+
|
|
1060
|
+
```python
|
|
1061
|
+
import spatialflow_generated
|
|
1062
|
+
from spatialflow_generated.rest import ApiException
|
|
1063
|
+
from pprint import pprint
|
|
1064
|
+
|
|
1065
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1066
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1067
|
+
configuration = spatialflow_generated.Configuration(
|
|
1068
|
+
host = "https://api.spatialflow.io"
|
|
1069
|
+
)
|
|
1070
|
+
|
|
1071
|
+
# The client must configure the authentication and authorization parameters
|
|
1072
|
+
# in accordance with the API server security policy.
|
|
1073
|
+
# Examples for each auth method are provided below, use the example that
|
|
1074
|
+
# satisfies your auth use case.
|
|
1075
|
+
|
|
1076
|
+
# Configure API key authorization: APIKeyBearer
|
|
1077
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1078
|
+
|
|
1079
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1080
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1081
|
+
|
|
1082
|
+
# Configure Bearer authorization: JWTBearer
|
|
1083
|
+
configuration = spatialflow_generated.Configuration(
|
|
1084
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1085
|
+
)
|
|
1086
|
+
|
|
1087
|
+
# Enter a context with an instance of the API client
|
|
1088
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1089
|
+
# Create an instance of the API class
|
|
1090
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
1091
|
+
webhook_id = 'webhook_id_example' # str |
|
|
1092
|
+
delivery_id = 'delivery_id_example' # str |
|
|
1093
|
+
|
|
1094
|
+
try:
|
|
1095
|
+
# Retry Webhook Delivery
|
|
1096
|
+
api_response = await api_instance.apps_webhooks_api_retry_webhook_delivery(webhook_id, delivery_id)
|
|
1097
|
+
print("The response of WebhooksApi->apps_webhooks_api_retry_webhook_delivery:\n")
|
|
1098
|
+
pprint(api_response)
|
|
1099
|
+
except Exception as e:
|
|
1100
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_retry_webhook_delivery: %s\n" % e)
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
### Parameters
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
Name | Type | Description | Notes
|
|
1109
|
+
------------- | ------------- | ------------- | -------------
|
|
1110
|
+
**webhook_id** | **str**| |
|
|
1111
|
+
**delivery_id** | **str**| |
|
|
1112
|
+
|
|
1113
|
+
### Return type
|
|
1114
|
+
|
|
1115
|
+
**Dict[str, object]**
|
|
1116
|
+
|
|
1117
|
+
### Authorization
|
|
1118
|
+
|
|
1119
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1120
|
+
|
|
1121
|
+
### HTTP request headers
|
|
1122
|
+
|
|
1123
|
+
- **Content-Type**: Not defined
|
|
1124
|
+
- **Accept**: application/json
|
|
1125
|
+
|
|
1126
|
+
### HTTP response details
|
|
1127
|
+
|
|
1128
|
+
| Status code | Description | Response headers |
|
|
1129
|
+
|-------------|-------------|------------------|
|
|
1130
|
+
**200** | OK | - |
|
|
1131
|
+
**400** | Bad Request | - |
|
|
1132
|
+
**401** | Unauthorized | - |
|
|
1133
|
+
**404** | Not Found | - |
|
|
1134
|
+
**500** | Internal Server Error | - |
|
|
1135
|
+
|
|
1136
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1137
|
+
|
|
1138
|
+
# **apps_webhooks_api_test_webhook**
|
|
1139
|
+
> WebhookTestResponse apps_webhooks_api_test_webhook(webhook_id, test_webhook_request)
|
|
1140
|
+
|
|
1141
|
+
Test Webhook
|
|
1142
|
+
|
|
1143
|
+
Test a webhook with a sample payload.
|
|
1144
|
+
|
|
1145
|
+
### Example
|
|
1146
|
+
|
|
1147
|
+
* Api Key Authentication (APIKeyBearer):
|
|
1148
|
+
* Bearer Authentication (JWTBearer):
|
|
1149
|
+
|
|
1150
|
+
```python
|
|
1151
|
+
import spatialflow_generated
|
|
1152
|
+
from spatialflow_generated.models.test_webhook_request import TestWebhookRequest
|
|
1153
|
+
from spatialflow_generated.models.webhook_test_response import WebhookTestResponse
|
|
1154
|
+
from spatialflow_generated.rest import ApiException
|
|
1155
|
+
from pprint import pprint
|
|
1156
|
+
|
|
1157
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1158
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1159
|
+
configuration = spatialflow_generated.Configuration(
|
|
1160
|
+
host = "https://api.spatialflow.io"
|
|
1161
|
+
)
|
|
1162
|
+
|
|
1163
|
+
# The client must configure the authentication and authorization parameters
|
|
1164
|
+
# in accordance with the API server security policy.
|
|
1165
|
+
# Examples for each auth method are provided below, use the example that
|
|
1166
|
+
# satisfies your auth use case.
|
|
1167
|
+
|
|
1168
|
+
# Configure API key authorization: APIKeyBearer
|
|
1169
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1170
|
+
|
|
1171
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1172
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1173
|
+
|
|
1174
|
+
# Configure Bearer authorization: JWTBearer
|
|
1175
|
+
configuration = spatialflow_generated.Configuration(
|
|
1176
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1177
|
+
)
|
|
1178
|
+
|
|
1179
|
+
# Enter a context with an instance of the API client
|
|
1180
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1181
|
+
# Create an instance of the API class
|
|
1182
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
1183
|
+
webhook_id = 'webhook_id_example' # str |
|
|
1184
|
+
test_webhook_request = spatialflow_generated.TestWebhookRequest() # TestWebhookRequest |
|
|
1185
|
+
|
|
1186
|
+
try:
|
|
1187
|
+
# Test Webhook
|
|
1188
|
+
api_response = await api_instance.apps_webhooks_api_test_webhook(webhook_id, test_webhook_request)
|
|
1189
|
+
print("The response of WebhooksApi->apps_webhooks_api_test_webhook:\n")
|
|
1190
|
+
pprint(api_response)
|
|
1191
|
+
except Exception as e:
|
|
1192
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_test_webhook: %s\n" % e)
|
|
1193
|
+
```
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
### Parameters
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
Name | Type | Description | Notes
|
|
1201
|
+
------------- | ------------- | ------------- | -------------
|
|
1202
|
+
**webhook_id** | **str**| |
|
|
1203
|
+
**test_webhook_request** | [**TestWebhookRequest**](TestWebhookRequest.md)| |
|
|
1204
|
+
|
|
1205
|
+
### Return type
|
|
1206
|
+
|
|
1207
|
+
[**WebhookTestResponse**](WebhookTestResponse.md)
|
|
1208
|
+
|
|
1209
|
+
### Authorization
|
|
1210
|
+
|
|
1211
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1212
|
+
|
|
1213
|
+
### HTTP request headers
|
|
1214
|
+
|
|
1215
|
+
- **Content-Type**: application/json
|
|
1216
|
+
- **Accept**: application/json
|
|
1217
|
+
|
|
1218
|
+
### HTTP response details
|
|
1219
|
+
|
|
1220
|
+
| Status code | Description | Response headers |
|
|
1221
|
+
|-------------|-------------|------------------|
|
|
1222
|
+
**200** | OK | - |
|
|
1223
|
+
**400** | Bad Request | - |
|
|
1224
|
+
**401** | Unauthorized | - |
|
|
1225
|
+
**404** | Not Found | - |
|
|
1226
|
+
**429** | Too Many Requests | - |
|
|
1227
|
+
|
|
1228
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1229
|
+
|
|
1230
|
+
# **apps_webhooks_api_update_webhook**
|
|
1231
|
+
> WebhookResponse apps_webhooks_api_update_webhook(webhook_id, update_webhook_request)
|
|
1232
|
+
|
|
1233
|
+
Update Webhook
|
|
1234
|
+
|
|
1235
|
+
Update an existing webhook.
|
|
1236
|
+
|
|
1237
|
+
### Example
|
|
1238
|
+
|
|
1239
|
+
* Api Key Authentication (APIKeyBearer):
|
|
1240
|
+
* Bearer Authentication (JWTBearer):
|
|
1241
|
+
|
|
1242
|
+
```python
|
|
1243
|
+
import spatialflow_generated
|
|
1244
|
+
from spatialflow_generated.models.update_webhook_request import UpdateWebhookRequest
|
|
1245
|
+
from spatialflow_generated.models.webhook_response import WebhookResponse
|
|
1246
|
+
from spatialflow_generated.rest import ApiException
|
|
1247
|
+
from pprint import pprint
|
|
1248
|
+
|
|
1249
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1250
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1251
|
+
configuration = spatialflow_generated.Configuration(
|
|
1252
|
+
host = "https://api.spatialflow.io"
|
|
1253
|
+
)
|
|
1254
|
+
|
|
1255
|
+
# The client must configure the authentication and authorization parameters
|
|
1256
|
+
# in accordance with the API server security policy.
|
|
1257
|
+
# Examples for each auth method are provided below, use the example that
|
|
1258
|
+
# satisfies your auth use case.
|
|
1259
|
+
|
|
1260
|
+
# Configure API key authorization: APIKeyBearer
|
|
1261
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1262
|
+
|
|
1263
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1264
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1265
|
+
|
|
1266
|
+
# Configure Bearer authorization: JWTBearer
|
|
1267
|
+
configuration = spatialflow_generated.Configuration(
|
|
1268
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1269
|
+
)
|
|
1270
|
+
|
|
1271
|
+
# Enter a context with an instance of the API client
|
|
1272
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1273
|
+
# Create an instance of the API class
|
|
1274
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
1275
|
+
webhook_id = 'webhook_id_example' # str |
|
|
1276
|
+
update_webhook_request = spatialflow_generated.UpdateWebhookRequest() # UpdateWebhookRequest |
|
|
1277
|
+
|
|
1278
|
+
try:
|
|
1279
|
+
# Update Webhook
|
|
1280
|
+
api_response = await api_instance.apps_webhooks_api_update_webhook(webhook_id, update_webhook_request)
|
|
1281
|
+
print("The response of WebhooksApi->apps_webhooks_api_update_webhook:\n")
|
|
1282
|
+
pprint(api_response)
|
|
1283
|
+
except Exception as e:
|
|
1284
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_update_webhook: %s\n" % e)
|
|
1285
|
+
```
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
### Parameters
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
Name | Type | Description | Notes
|
|
1293
|
+
------------- | ------------- | ------------- | -------------
|
|
1294
|
+
**webhook_id** | **str**| |
|
|
1295
|
+
**update_webhook_request** | [**UpdateWebhookRequest**](UpdateWebhookRequest.md)| |
|
|
1296
|
+
|
|
1297
|
+
### Return type
|
|
1298
|
+
|
|
1299
|
+
[**WebhookResponse**](WebhookResponse.md)
|
|
1300
|
+
|
|
1301
|
+
### Authorization
|
|
1302
|
+
|
|
1303
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1304
|
+
|
|
1305
|
+
### HTTP request headers
|
|
1306
|
+
|
|
1307
|
+
- **Content-Type**: application/json
|
|
1308
|
+
- **Accept**: application/json
|
|
1309
|
+
|
|
1310
|
+
### HTTP response details
|
|
1311
|
+
|
|
1312
|
+
| Status code | Description | Response headers |
|
|
1313
|
+
|-------------|-------------|------------------|
|
|
1314
|
+
**200** | OK | - |
|
|
1315
|
+
**400** | Bad Request | - |
|
|
1316
|
+
**401** | Unauthorized | - |
|
|
1317
|
+
**404** | Not Found | - |
|
|
1318
|
+
|
|
1319
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1320
|
+
|
|
1321
|
+
# **apps_webhooks_api_webhook_health_check**
|
|
1322
|
+
> Dict[str, object] apps_webhooks_api_webhook_health_check()
|
|
1323
|
+
|
|
1324
|
+
Webhook Health Check
|
|
1325
|
+
|
|
1326
|
+
Health check for webhook service.
|
|
1327
|
+
|
|
1328
|
+
### Example
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
```python
|
|
1332
|
+
import spatialflow_generated
|
|
1333
|
+
from spatialflow_generated.rest import ApiException
|
|
1334
|
+
from pprint import pprint
|
|
1335
|
+
|
|
1336
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1337
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1338
|
+
configuration = spatialflow_generated.Configuration(
|
|
1339
|
+
host = "https://api.spatialflow.io"
|
|
1340
|
+
)
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
# Enter a context with an instance of the API client
|
|
1344
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1345
|
+
# Create an instance of the API class
|
|
1346
|
+
api_instance = spatialflow_generated.WebhooksApi(api_client)
|
|
1347
|
+
|
|
1348
|
+
try:
|
|
1349
|
+
# Webhook Health Check
|
|
1350
|
+
api_response = await api_instance.apps_webhooks_api_webhook_health_check()
|
|
1351
|
+
print("The response of WebhooksApi->apps_webhooks_api_webhook_health_check:\n")
|
|
1352
|
+
pprint(api_response)
|
|
1353
|
+
except Exception as e:
|
|
1354
|
+
print("Exception when calling WebhooksApi->apps_webhooks_api_webhook_health_check: %s\n" % e)
|
|
1355
|
+
```
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
### Parameters
|
|
1360
|
+
|
|
1361
|
+
This endpoint does not need any parameter.
|
|
1362
|
+
|
|
1363
|
+
### Return type
|
|
1364
|
+
|
|
1365
|
+
**Dict[str, object]**
|
|
1366
|
+
|
|
1367
|
+
### Authorization
|
|
1368
|
+
|
|
1369
|
+
No authorization required
|
|
1370
|
+
|
|
1371
|
+
### HTTP request headers
|
|
1372
|
+
|
|
1373
|
+
- **Content-Type**: Not defined
|
|
1374
|
+
- **Accept**: application/json
|
|
1375
|
+
|
|
1376
|
+
### HTTP response details
|
|
1377
|
+
|
|
1378
|
+
| Status code | Description | Response headers |
|
|
1379
|
+
|-------------|-------------|------------------|
|
|
1380
|
+
**200** | OK | - |
|
|
1381
|
+
**503** | Service Unavailable | - |
|
|
1382
|
+
|
|
1383
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1384
|
+
|