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,1524 @@
|
|
|
1
|
+
# spatialflow_generated.GeofencesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.spatialflow.io*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**apps_geofences_api_bulk_create_geofences**](GeofencesApi.md#apps_geofences_api_bulk_create_geofences) | **POST** /api/v1/geofences/bulk | Bulk Create Geofences
|
|
8
|
+
[**apps_geofences_api_create_geofence**](GeofencesApi.md#apps_geofences_api_create_geofence) | **POST** /api/v1/geofences/ | Create Geofence
|
|
9
|
+
[**apps_geofences_api_delete_geofence**](GeofencesApi.md#apps_geofences_api_delete_geofence) | **DELETE** /api/v1/geofences/{geofence_id} | Delete Geofence
|
|
10
|
+
[**apps_geofences_api_geofence_health_check**](GeofencesApi.md#apps_geofences_api_geofence_health_check) | **GET** /api/v1/geofences/health | Geofence Health Check
|
|
11
|
+
[**apps_geofences_api_get_active_geofences_summary**](GeofencesApi.md#apps_geofences_api_get_active_geofences_summary) | **GET** /api/v1/geofences/active-summary | Get Active Geofences Summary
|
|
12
|
+
[**apps_geofences_api_get_geofence**](GeofencesApi.md#apps_geofences_api_get_geofence) | **GET** /api/v1/geofences/{geofence_id} | Get Geofence
|
|
13
|
+
[**apps_geofences_api_get_test_event_history**](GeofencesApi.md#apps_geofences_api_get_test_event_history) | **GET** /api/v1/geofences/{geofence_id}/test-events | Get Test Event History
|
|
14
|
+
[**apps_geofences_api_get_upload_job_status**](GeofencesApi.md#apps_geofences_api_get_upload_job_status) | **GET** /api/v1/geofences/upload/{job_id}/status | Get Upload Job Status
|
|
15
|
+
[**apps_geofences_api_list_geofence_groups**](GeofencesApi.md#apps_geofences_api_list_geofence_groups) | **GET** /api/v1/geofences/groups | List Geofence Groups
|
|
16
|
+
[**apps_geofences_api_list_geofences**](GeofencesApi.md#apps_geofences_api_list_geofences) | **GET** /api/v1/geofences/ | List Geofences
|
|
17
|
+
[**apps_geofences_api_list_group_geofences**](GeofencesApi.md#apps_geofences_api_list_group_geofences) | **GET** /api/v1/geofences/groups/{group_id}/geofences | List Group Geofences
|
|
18
|
+
[**apps_geofences_api_test_group_point**](GeofencesApi.md#apps_geofences_api_test_group_point) | **POST** /api/v1/geofences/groups/{group_id}/test-point | Test Group Point
|
|
19
|
+
[**apps_geofences_api_test_point**](GeofencesApi.md#apps_geofences_api_test_point) | **POST** /api/v1/geofences/test-point | Test Point
|
|
20
|
+
[**apps_geofences_api_trigger_test_event**](GeofencesApi.md#apps_geofences_api_trigger_test_event) | **POST** /api/v1/geofences/{geofence_id}/test-event | Trigger Test Event
|
|
21
|
+
[**apps_geofences_api_update_geofence**](GeofencesApi.md#apps_geofences_api_update_geofence) | **PUT** /api/v1/geofences/{geofence_id} | Update Geofence
|
|
22
|
+
[**apps_geofences_api_update_geofence_group**](GeofencesApi.md#apps_geofences_api_update_geofence_group) | **PUT** /api/v1/geofences/{geofence_id}/group | Update Geofence Group
|
|
23
|
+
[**apps_geofences_api_upload_geofences_async**](GeofencesApi.md#apps_geofences_api_upload_geofences_async) | **POST** /api/v1/geofences/upload | Upload Geofences Async
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
# **apps_geofences_api_bulk_create_geofences**
|
|
27
|
+
> Dict[str, object] apps_geofences_api_bulk_create_geofences(bulk_geofence_request)
|
|
28
|
+
|
|
29
|
+
Bulk Create Geofences
|
|
30
|
+
|
|
31
|
+
Bulk create multiple geofences. This endpoint allows users with the BATCH_OPERATIONS feature to create multiple geofences in a single request. Maximum 100 geofences per request.
|
|
32
|
+
|
|
33
|
+
### Example
|
|
34
|
+
|
|
35
|
+
* Api Key Authentication (APIKeyBearer):
|
|
36
|
+
* Bearer Authentication (JWTBearer):
|
|
37
|
+
|
|
38
|
+
```python
|
|
39
|
+
import spatialflow_generated
|
|
40
|
+
from spatialflow_generated.models.bulk_geofence_request import BulkGeofenceRequest
|
|
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.GeofencesApi(api_client)
|
|
70
|
+
bulk_geofence_request = spatialflow_generated.BulkGeofenceRequest() # BulkGeofenceRequest |
|
|
71
|
+
|
|
72
|
+
try:
|
|
73
|
+
# Bulk Create Geofences
|
|
74
|
+
api_response = await api_instance.apps_geofences_api_bulk_create_geofences(bulk_geofence_request)
|
|
75
|
+
print("The response of GeofencesApi->apps_geofences_api_bulk_create_geofences:\n")
|
|
76
|
+
pprint(api_response)
|
|
77
|
+
except Exception as e:
|
|
78
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_bulk_create_geofences: %s\n" % e)
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
Name | Type | Description | Notes
|
|
87
|
+
------------- | ------------- | ------------- | -------------
|
|
88
|
+
**bulk_geofence_request** | [**BulkGeofenceRequest**](BulkGeofenceRequest.md)| |
|
|
89
|
+
|
|
90
|
+
### Return type
|
|
91
|
+
|
|
92
|
+
**Dict[str, object]**
|
|
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
|
+
**403** | Forbidden | - |
|
|
110
|
+
|
|
111
|
+
[[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)
|
|
112
|
+
|
|
113
|
+
# **apps_geofences_api_create_geofence**
|
|
114
|
+
> GeofenceResponse apps_geofences_api_create_geofence(create_geofence_request)
|
|
115
|
+
|
|
116
|
+
Create Geofence
|
|
117
|
+
|
|
118
|
+
Create new polygon geofence.
|
|
119
|
+
|
|
120
|
+
### Example
|
|
121
|
+
|
|
122
|
+
* Api Key Authentication (APIKeyBearer):
|
|
123
|
+
* Bearer Authentication (JWTBearer):
|
|
124
|
+
|
|
125
|
+
```python
|
|
126
|
+
import spatialflow_generated
|
|
127
|
+
from spatialflow_generated.models.create_geofence_request import CreateGeofenceRequest
|
|
128
|
+
from spatialflow_generated.models.geofence_response import GeofenceResponse
|
|
129
|
+
from spatialflow_generated.rest import ApiException
|
|
130
|
+
from pprint import pprint
|
|
131
|
+
|
|
132
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
133
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
134
|
+
configuration = spatialflow_generated.Configuration(
|
|
135
|
+
host = "https://api.spatialflow.io"
|
|
136
|
+
)
|
|
137
|
+
|
|
138
|
+
# The client must configure the authentication and authorization parameters
|
|
139
|
+
# in accordance with the API server security policy.
|
|
140
|
+
# Examples for each auth method are provided below, use the example that
|
|
141
|
+
# satisfies your auth use case.
|
|
142
|
+
|
|
143
|
+
# Configure API key authorization: APIKeyBearer
|
|
144
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
145
|
+
|
|
146
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
147
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
148
|
+
|
|
149
|
+
# Configure Bearer authorization: JWTBearer
|
|
150
|
+
configuration = spatialflow_generated.Configuration(
|
|
151
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
152
|
+
)
|
|
153
|
+
|
|
154
|
+
# Enter a context with an instance of the API client
|
|
155
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
156
|
+
# Create an instance of the API class
|
|
157
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
158
|
+
create_geofence_request = spatialflow_generated.CreateGeofenceRequest() # CreateGeofenceRequest |
|
|
159
|
+
|
|
160
|
+
try:
|
|
161
|
+
# Create Geofence
|
|
162
|
+
api_response = await api_instance.apps_geofences_api_create_geofence(create_geofence_request)
|
|
163
|
+
print("The response of GeofencesApi->apps_geofences_api_create_geofence:\n")
|
|
164
|
+
pprint(api_response)
|
|
165
|
+
except Exception as e:
|
|
166
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_create_geofence: %s\n" % e)
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
### Parameters
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
Name | Type | Description | Notes
|
|
175
|
+
------------- | ------------- | ------------- | -------------
|
|
176
|
+
**create_geofence_request** | [**CreateGeofenceRequest**](CreateGeofenceRequest.md)| |
|
|
177
|
+
|
|
178
|
+
### Return type
|
|
179
|
+
|
|
180
|
+
[**GeofenceResponse**](GeofenceResponse.md)
|
|
181
|
+
|
|
182
|
+
### Authorization
|
|
183
|
+
|
|
184
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
185
|
+
|
|
186
|
+
### HTTP request headers
|
|
187
|
+
|
|
188
|
+
- **Content-Type**: application/json
|
|
189
|
+
- **Accept**: application/json
|
|
190
|
+
|
|
191
|
+
### HTTP response details
|
|
192
|
+
|
|
193
|
+
| Status code | Description | Response headers |
|
|
194
|
+
|-------------|-------------|------------------|
|
|
195
|
+
**201** | Created | - |
|
|
196
|
+
**400** | Bad Request | - |
|
|
197
|
+
**401** | Unauthorized | - |
|
|
198
|
+
**429** | Too Many Requests | - |
|
|
199
|
+
**500** | Internal Server Error | - |
|
|
200
|
+
**501** | Not Implemented | - |
|
|
201
|
+
**502** | Bad Gateway | - |
|
|
202
|
+
**503** | Service Unavailable | - |
|
|
203
|
+
**504** | Gateway Timeout | - |
|
|
204
|
+
|
|
205
|
+
[[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)
|
|
206
|
+
|
|
207
|
+
# **apps_geofences_api_delete_geofence**
|
|
208
|
+
> Dict[str, object] apps_geofences_api_delete_geofence(geofence_id)
|
|
209
|
+
|
|
210
|
+
Delete Geofence
|
|
211
|
+
|
|
212
|
+
Delete (deactivate) geofence.
|
|
213
|
+
|
|
214
|
+
### Example
|
|
215
|
+
|
|
216
|
+
* Api Key Authentication (APIKeyBearer):
|
|
217
|
+
* Bearer Authentication (JWTBearer):
|
|
218
|
+
|
|
219
|
+
```python
|
|
220
|
+
import spatialflow_generated
|
|
221
|
+
from spatialflow_generated.rest import ApiException
|
|
222
|
+
from pprint import pprint
|
|
223
|
+
|
|
224
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
225
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
226
|
+
configuration = spatialflow_generated.Configuration(
|
|
227
|
+
host = "https://api.spatialflow.io"
|
|
228
|
+
)
|
|
229
|
+
|
|
230
|
+
# The client must configure the authentication and authorization parameters
|
|
231
|
+
# in accordance with the API server security policy.
|
|
232
|
+
# Examples for each auth method are provided below, use the example that
|
|
233
|
+
# satisfies your auth use case.
|
|
234
|
+
|
|
235
|
+
# Configure API key authorization: APIKeyBearer
|
|
236
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
237
|
+
|
|
238
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
239
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
240
|
+
|
|
241
|
+
# Configure Bearer authorization: JWTBearer
|
|
242
|
+
configuration = spatialflow_generated.Configuration(
|
|
243
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
244
|
+
)
|
|
245
|
+
|
|
246
|
+
# Enter a context with an instance of the API client
|
|
247
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
248
|
+
# Create an instance of the API class
|
|
249
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
250
|
+
geofence_id = 'geofence_id_example' # str |
|
|
251
|
+
|
|
252
|
+
try:
|
|
253
|
+
# Delete Geofence
|
|
254
|
+
api_response = await api_instance.apps_geofences_api_delete_geofence(geofence_id)
|
|
255
|
+
print("The response of GeofencesApi->apps_geofences_api_delete_geofence:\n")
|
|
256
|
+
pprint(api_response)
|
|
257
|
+
except Exception as e:
|
|
258
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_delete_geofence: %s\n" % e)
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
### Parameters
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
Name | Type | Description | Notes
|
|
267
|
+
------------- | ------------- | ------------- | -------------
|
|
268
|
+
**geofence_id** | **str**| |
|
|
269
|
+
|
|
270
|
+
### Return type
|
|
271
|
+
|
|
272
|
+
**Dict[str, object]**
|
|
273
|
+
|
|
274
|
+
### Authorization
|
|
275
|
+
|
|
276
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
277
|
+
|
|
278
|
+
### HTTP request headers
|
|
279
|
+
|
|
280
|
+
- **Content-Type**: Not defined
|
|
281
|
+
- **Accept**: application/json
|
|
282
|
+
|
|
283
|
+
### HTTP response details
|
|
284
|
+
|
|
285
|
+
| Status code | Description | Response headers |
|
|
286
|
+
|-------------|-------------|------------------|
|
|
287
|
+
**200** | OK | - |
|
|
288
|
+
**401** | Unauthorized | - |
|
|
289
|
+
**404** | Not Found | - |
|
|
290
|
+
**500** | Internal Server Error | - |
|
|
291
|
+
**501** | Not Implemented | - |
|
|
292
|
+
**502** | Bad Gateway | - |
|
|
293
|
+
**503** | Service Unavailable | - |
|
|
294
|
+
**504** | Gateway Timeout | - |
|
|
295
|
+
|
|
296
|
+
[[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)
|
|
297
|
+
|
|
298
|
+
# **apps_geofences_api_geofence_health_check**
|
|
299
|
+
> Dict[str, object] apps_geofences_api_geofence_health_check()
|
|
300
|
+
|
|
301
|
+
Geofence Health Check
|
|
302
|
+
|
|
303
|
+
Health check for geofence service.
|
|
304
|
+
|
|
305
|
+
### Example
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
```python
|
|
309
|
+
import spatialflow_generated
|
|
310
|
+
from spatialflow_generated.rest import ApiException
|
|
311
|
+
from pprint import pprint
|
|
312
|
+
|
|
313
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
314
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
315
|
+
configuration = spatialflow_generated.Configuration(
|
|
316
|
+
host = "https://api.spatialflow.io"
|
|
317
|
+
)
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
# Enter a context with an instance of the API client
|
|
321
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
322
|
+
# Create an instance of the API class
|
|
323
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
324
|
+
|
|
325
|
+
try:
|
|
326
|
+
# Geofence Health Check
|
|
327
|
+
api_response = await api_instance.apps_geofences_api_geofence_health_check()
|
|
328
|
+
print("The response of GeofencesApi->apps_geofences_api_geofence_health_check:\n")
|
|
329
|
+
pprint(api_response)
|
|
330
|
+
except Exception as e:
|
|
331
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_geofence_health_check: %s\n" % e)
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
### Parameters
|
|
337
|
+
|
|
338
|
+
This endpoint does not need any parameter.
|
|
339
|
+
|
|
340
|
+
### Return type
|
|
341
|
+
|
|
342
|
+
**Dict[str, object]**
|
|
343
|
+
|
|
344
|
+
### Authorization
|
|
345
|
+
|
|
346
|
+
No authorization required
|
|
347
|
+
|
|
348
|
+
### HTTP request headers
|
|
349
|
+
|
|
350
|
+
- **Content-Type**: Not defined
|
|
351
|
+
- **Accept**: application/json
|
|
352
|
+
|
|
353
|
+
### HTTP response details
|
|
354
|
+
|
|
355
|
+
| Status code | Description | Response headers |
|
|
356
|
+
|-------------|-------------|------------------|
|
|
357
|
+
**200** | OK | - |
|
|
358
|
+
|
|
359
|
+
[[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)
|
|
360
|
+
|
|
361
|
+
# **apps_geofences_api_get_active_geofences_summary**
|
|
362
|
+
> Dict[str, object] apps_geofences_api_get_active_geofences_summary()
|
|
363
|
+
|
|
364
|
+
Get Active Geofences Summary
|
|
365
|
+
|
|
366
|
+
Get summary of active geofences with event counts for dashboard map widget.
|
|
367
|
+
|
|
368
|
+
### Example
|
|
369
|
+
|
|
370
|
+
* Api Key Authentication (APIKeyBearer):
|
|
371
|
+
* Bearer Authentication (JWTBearer):
|
|
372
|
+
|
|
373
|
+
```python
|
|
374
|
+
import spatialflow_generated
|
|
375
|
+
from spatialflow_generated.rest import ApiException
|
|
376
|
+
from pprint import pprint
|
|
377
|
+
|
|
378
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
379
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
380
|
+
configuration = spatialflow_generated.Configuration(
|
|
381
|
+
host = "https://api.spatialflow.io"
|
|
382
|
+
)
|
|
383
|
+
|
|
384
|
+
# The client must configure the authentication and authorization parameters
|
|
385
|
+
# in accordance with the API server security policy.
|
|
386
|
+
# Examples for each auth method are provided below, use the example that
|
|
387
|
+
# satisfies your auth use case.
|
|
388
|
+
|
|
389
|
+
# Configure API key authorization: APIKeyBearer
|
|
390
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
391
|
+
|
|
392
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
393
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
394
|
+
|
|
395
|
+
# Configure Bearer authorization: JWTBearer
|
|
396
|
+
configuration = spatialflow_generated.Configuration(
|
|
397
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
398
|
+
)
|
|
399
|
+
|
|
400
|
+
# Enter a context with an instance of the API client
|
|
401
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
402
|
+
# Create an instance of the API class
|
|
403
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
404
|
+
|
|
405
|
+
try:
|
|
406
|
+
# Get Active Geofences Summary
|
|
407
|
+
api_response = await api_instance.apps_geofences_api_get_active_geofences_summary()
|
|
408
|
+
print("The response of GeofencesApi->apps_geofences_api_get_active_geofences_summary:\n")
|
|
409
|
+
pprint(api_response)
|
|
410
|
+
except Exception as e:
|
|
411
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_get_active_geofences_summary: %s\n" % e)
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
### Parameters
|
|
417
|
+
|
|
418
|
+
This endpoint does not need any parameter.
|
|
419
|
+
|
|
420
|
+
### Return type
|
|
421
|
+
|
|
422
|
+
**Dict[str, object]**
|
|
423
|
+
|
|
424
|
+
### Authorization
|
|
425
|
+
|
|
426
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
427
|
+
|
|
428
|
+
### HTTP request headers
|
|
429
|
+
|
|
430
|
+
- **Content-Type**: Not defined
|
|
431
|
+
- **Accept**: application/json
|
|
432
|
+
|
|
433
|
+
### HTTP response details
|
|
434
|
+
|
|
435
|
+
| Status code | Description | Response headers |
|
|
436
|
+
|-------------|-------------|------------------|
|
|
437
|
+
**200** | OK | - |
|
|
438
|
+
|
|
439
|
+
[[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)
|
|
440
|
+
|
|
441
|
+
# **apps_geofences_api_get_geofence**
|
|
442
|
+
> GeofenceResponse apps_geofences_api_get_geofence(geofence_id)
|
|
443
|
+
|
|
444
|
+
Get Geofence
|
|
445
|
+
|
|
446
|
+
Get a specific geofence by its ID.
|
|
447
|
+
|
|
448
|
+
### Example
|
|
449
|
+
|
|
450
|
+
* Api Key Authentication (APIKeyBearer):
|
|
451
|
+
* Bearer Authentication (JWTBearer):
|
|
452
|
+
|
|
453
|
+
```python
|
|
454
|
+
import spatialflow_generated
|
|
455
|
+
from spatialflow_generated.models.geofence_response import GeofenceResponse
|
|
456
|
+
from spatialflow_generated.rest import ApiException
|
|
457
|
+
from pprint import pprint
|
|
458
|
+
|
|
459
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
460
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
461
|
+
configuration = spatialflow_generated.Configuration(
|
|
462
|
+
host = "https://api.spatialflow.io"
|
|
463
|
+
)
|
|
464
|
+
|
|
465
|
+
# The client must configure the authentication and authorization parameters
|
|
466
|
+
# in accordance with the API server security policy.
|
|
467
|
+
# Examples for each auth method are provided below, use the example that
|
|
468
|
+
# satisfies your auth use case.
|
|
469
|
+
|
|
470
|
+
# Configure API key authorization: APIKeyBearer
|
|
471
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
472
|
+
|
|
473
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
474
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
475
|
+
|
|
476
|
+
# Configure Bearer authorization: JWTBearer
|
|
477
|
+
configuration = spatialflow_generated.Configuration(
|
|
478
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
479
|
+
)
|
|
480
|
+
|
|
481
|
+
# Enter a context with an instance of the API client
|
|
482
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
483
|
+
# Create an instance of the API class
|
|
484
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
485
|
+
geofence_id = 'geofence_id_example' # str |
|
|
486
|
+
|
|
487
|
+
try:
|
|
488
|
+
# Get Geofence
|
|
489
|
+
api_response = await api_instance.apps_geofences_api_get_geofence(geofence_id)
|
|
490
|
+
print("The response of GeofencesApi->apps_geofences_api_get_geofence:\n")
|
|
491
|
+
pprint(api_response)
|
|
492
|
+
except Exception as e:
|
|
493
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_get_geofence: %s\n" % e)
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
### Parameters
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
Name | Type | Description | Notes
|
|
502
|
+
------------- | ------------- | ------------- | -------------
|
|
503
|
+
**geofence_id** | **str**| |
|
|
504
|
+
|
|
505
|
+
### Return type
|
|
506
|
+
|
|
507
|
+
[**GeofenceResponse**](GeofenceResponse.md)
|
|
508
|
+
|
|
509
|
+
### Authorization
|
|
510
|
+
|
|
511
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
512
|
+
|
|
513
|
+
### HTTP request headers
|
|
514
|
+
|
|
515
|
+
- **Content-Type**: Not defined
|
|
516
|
+
- **Accept**: application/json
|
|
517
|
+
|
|
518
|
+
### HTTP response details
|
|
519
|
+
|
|
520
|
+
| Status code | Description | Response headers |
|
|
521
|
+
|-------------|-------------|------------------|
|
|
522
|
+
**200** | OK | - |
|
|
523
|
+
**401** | Unauthorized | - |
|
|
524
|
+
**404** | Not Found | - |
|
|
525
|
+
**500** | Internal Server Error | - |
|
|
526
|
+
**501** | Not Implemented | - |
|
|
527
|
+
**502** | Bad Gateway | - |
|
|
528
|
+
**503** | Service Unavailable | - |
|
|
529
|
+
**504** | Gateway Timeout | - |
|
|
530
|
+
|
|
531
|
+
[[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)
|
|
532
|
+
|
|
533
|
+
# **apps_geofences_api_get_test_event_history**
|
|
534
|
+
> apps_geofences_api_get_test_event_history(geofence_id, limit=limit, offset=offset)
|
|
535
|
+
|
|
536
|
+
Get Test Event History
|
|
537
|
+
|
|
538
|
+
Get test event history for a geofence. Args: geofence_id: ID of the geofence limit: Maximum number of events to return (default 50, max 100) offset: Number of events to skip (for pagination) Returns: List of test events with execution details
|
|
539
|
+
|
|
540
|
+
### Example
|
|
541
|
+
|
|
542
|
+
* Api Key Authentication (APIKeyBearer):
|
|
543
|
+
* Bearer Authentication (JWTBearer):
|
|
544
|
+
|
|
545
|
+
```python
|
|
546
|
+
import spatialflow_generated
|
|
547
|
+
from spatialflow_generated.rest import ApiException
|
|
548
|
+
from pprint import pprint
|
|
549
|
+
|
|
550
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
551
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
552
|
+
configuration = spatialflow_generated.Configuration(
|
|
553
|
+
host = "https://api.spatialflow.io"
|
|
554
|
+
)
|
|
555
|
+
|
|
556
|
+
# The client must configure the authentication and authorization parameters
|
|
557
|
+
# in accordance with the API server security policy.
|
|
558
|
+
# Examples for each auth method are provided below, use the example that
|
|
559
|
+
# satisfies your auth use case.
|
|
560
|
+
|
|
561
|
+
# Configure API key authorization: APIKeyBearer
|
|
562
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
563
|
+
|
|
564
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
565
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
566
|
+
|
|
567
|
+
# Configure Bearer authorization: JWTBearer
|
|
568
|
+
configuration = spatialflow_generated.Configuration(
|
|
569
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
570
|
+
)
|
|
571
|
+
|
|
572
|
+
# Enter a context with an instance of the API client
|
|
573
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
574
|
+
# Create an instance of the API class
|
|
575
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
576
|
+
geofence_id = 'geofence_id_example' # str |
|
|
577
|
+
limit = 50 # int | (optional) (default to 50)
|
|
578
|
+
offset = 0 # int | (optional) (default to 0)
|
|
579
|
+
|
|
580
|
+
try:
|
|
581
|
+
# Get Test Event History
|
|
582
|
+
await api_instance.apps_geofences_api_get_test_event_history(geofence_id, limit=limit, offset=offset)
|
|
583
|
+
except Exception as e:
|
|
584
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_get_test_event_history: %s\n" % e)
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
### Parameters
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
Name | Type | Description | Notes
|
|
593
|
+
------------- | ------------- | ------------- | -------------
|
|
594
|
+
**geofence_id** | **str**| |
|
|
595
|
+
**limit** | **int**| | [optional] [default to 50]
|
|
596
|
+
**offset** | **int**| | [optional] [default to 0]
|
|
597
|
+
|
|
598
|
+
### Return type
|
|
599
|
+
|
|
600
|
+
void (empty response body)
|
|
601
|
+
|
|
602
|
+
### Authorization
|
|
603
|
+
|
|
604
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
605
|
+
|
|
606
|
+
### HTTP request headers
|
|
607
|
+
|
|
608
|
+
- **Content-Type**: Not defined
|
|
609
|
+
- **Accept**: Not defined
|
|
610
|
+
|
|
611
|
+
### HTTP response details
|
|
612
|
+
|
|
613
|
+
| Status code | Description | Response headers |
|
|
614
|
+
|-------------|-------------|------------------|
|
|
615
|
+
**200** | OK | - |
|
|
616
|
+
|
|
617
|
+
[[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)
|
|
618
|
+
|
|
619
|
+
# **apps_geofences_api_get_upload_job_status**
|
|
620
|
+
> UploadJobStatus apps_geofences_api_get_upload_job_status(job_id)
|
|
621
|
+
|
|
622
|
+
Get Upload Job Status
|
|
623
|
+
|
|
624
|
+
Get the status of a geofence upload job. Returns current status, progress, and results (when completed) of the upload job.
|
|
625
|
+
|
|
626
|
+
### Example
|
|
627
|
+
|
|
628
|
+
* Api Key Authentication (APIKeyBearer):
|
|
629
|
+
* Bearer Authentication (JWTBearer):
|
|
630
|
+
|
|
631
|
+
```python
|
|
632
|
+
import spatialflow_generated
|
|
633
|
+
from spatialflow_generated.models.upload_job_status import UploadJobStatus
|
|
634
|
+
from spatialflow_generated.rest import ApiException
|
|
635
|
+
from pprint import pprint
|
|
636
|
+
|
|
637
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
638
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
639
|
+
configuration = spatialflow_generated.Configuration(
|
|
640
|
+
host = "https://api.spatialflow.io"
|
|
641
|
+
)
|
|
642
|
+
|
|
643
|
+
# The client must configure the authentication and authorization parameters
|
|
644
|
+
# in accordance with the API server security policy.
|
|
645
|
+
# Examples for each auth method are provided below, use the example that
|
|
646
|
+
# satisfies your auth use case.
|
|
647
|
+
|
|
648
|
+
# Configure API key authorization: APIKeyBearer
|
|
649
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
650
|
+
|
|
651
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
652
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
653
|
+
|
|
654
|
+
# Configure Bearer authorization: JWTBearer
|
|
655
|
+
configuration = spatialflow_generated.Configuration(
|
|
656
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
657
|
+
)
|
|
658
|
+
|
|
659
|
+
# Enter a context with an instance of the API client
|
|
660
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
661
|
+
# Create an instance of the API class
|
|
662
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
663
|
+
job_id = 'job_id_example' # str |
|
|
664
|
+
|
|
665
|
+
try:
|
|
666
|
+
# Get Upload Job Status
|
|
667
|
+
api_response = await api_instance.apps_geofences_api_get_upload_job_status(job_id)
|
|
668
|
+
print("The response of GeofencesApi->apps_geofences_api_get_upload_job_status:\n")
|
|
669
|
+
pprint(api_response)
|
|
670
|
+
except Exception as e:
|
|
671
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_get_upload_job_status: %s\n" % e)
|
|
672
|
+
```
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
### Parameters
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
Name | Type | Description | Notes
|
|
680
|
+
------------- | ------------- | ------------- | -------------
|
|
681
|
+
**job_id** | **str**| |
|
|
682
|
+
|
|
683
|
+
### Return type
|
|
684
|
+
|
|
685
|
+
[**UploadJobStatus**](UploadJobStatus.md)
|
|
686
|
+
|
|
687
|
+
### Authorization
|
|
688
|
+
|
|
689
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
690
|
+
|
|
691
|
+
### HTTP request headers
|
|
692
|
+
|
|
693
|
+
- **Content-Type**: Not defined
|
|
694
|
+
- **Accept**: application/json
|
|
695
|
+
|
|
696
|
+
### HTTP response details
|
|
697
|
+
|
|
698
|
+
| Status code | Description | Response headers |
|
|
699
|
+
|-------------|-------------|------------------|
|
|
700
|
+
**200** | OK | - |
|
|
701
|
+
**401** | Unauthorized | - |
|
|
702
|
+
**404** | Not Found | - |
|
|
703
|
+
**500** | Internal Server Error | - |
|
|
704
|
+
**501** | Not Implemented | - |
|
|
705
|
+
**502** | Bad Gateway | - |
|
|
706
|
+
**503** | Service Unavailable | - |
|
|
707
|
+
**504** | Gateway Timeout | - |
|
|
708
|
+
|
|
709
|
+
[[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)
|
|
710
|
+
|
|
711
|
+
# **apps_geofences_api_list_geofence_groups**
|
|
712
|
+
> Dict[str, object] apps_geofences_api_list_geofence_groups()
|
|
713
|
+
|
|
714
|
+
List Geofence Groups
|
|
715
|
+
|
|
716
|
+
List all unique groups for the current user.
|
|
717
|
+
|
|
718
|
+
### Example
|
|
719
|
+
|
|
720
|
+
* Api Key Authentication (APIKeyBearer):
|
|
721
|
+
* Bearer Authentication (JWTBearer):
|
|
722
|
+
|
|
723
|
+
```python
|
|
724
|
+
import spatialflow_generated
|
|
725
|
+
from spatialflow_generated.rest import ApiException
|
|
726
|
+
from pprint import pprint
|
|
727
|
+
|
|
728
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
729
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
730
|
+
configuration = spatialflow_generated.Configuration(
|
|
731
|
+
host = "https://api.spatialflow.io"
|
|
732
|
+
)
|
|
733
|
+
|
|
734
|
+
# The client must configure the authentication and authorization parameters
|
|
735
|
+
# in accordance with the API server security policy.
|
|
736
|
+
# Examples for each auth method are provided below, use the example that
|
|
737
|
+
# satisfies your auth use case.
|
|
738
|
+
|
|
739
|
+
# Configure API key authorization: APIKeyBearer
|
|
740
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
741
|
+
|
|
742
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
743
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
744
|
+
|
|
745
|
+
# Configure Bearer authorization: JWTBearer
|
|
746
|
+
configuration = spatialflow_generated.Configuration(
|
|
747
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
748
|
+
)
|
|
749
|
+
|
|
750
|
+
# Enter a context with an instance of the API client
|
|
751
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
752
|
+
# Create an instance of the API class
|
|
753
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
754
|
+
|
|
755
|
+
try:
|
|
756
|
+
# List Geofence Groups
|
|
757
|
+
api_response = await api_instance.apps_geofences_api_list_geofence_groups()
|
|
758
|
+
print("The response of GeofencesApi->apps_geofences_api_list_geofence_groups:\n")
|
|
759
|
+
pprint(api_response)
|
|
760
|
+
except Exception as e:
|
|
761
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_list_geofence_groups: %s\n" % e)
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
### Parameters
|
|
767
|
+
|
|
768
|
+
This endpoint does not need any parameter.
|
|
769
|
+
|
|
770
|
+
### Return type
|
|
771
|
+
|
|
772
|
+
**Dict[str, object]**
|
|
773
|
+
|
|
774
|
+
### Authorization
|
|
775
|
+
|
|
776
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
777
|
+
|
|
778
|
+
### HTTP request headers
|
|
779
|
+
|
|
780
|
+
- **Content-Type**: Not defined
|
|
781
|
+
- **Accept**: application/json
|
|
782
|
+
|
|
783
|
+
### HTTP response details
|
|
784
|
+
|
|
785
|
+
| Status code | Description | Response headers |
|
|
786
|
+
|-------------|-------------|------------------|
|
|
787
|
+
**200** | OK | - |
|
|
788
|
+
|
|
789
|
+
[[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)
|
|
790
|
+
|
|
791
|
+
# **apps_geofences_api_list_geofences**
|
|
792
|
+
> GeofenceListResponse apps_geofences_api_list_geofences(limit=limit, offset=offset, active_only=active_only)
|
|
793
|
+
|
|
794
|
+
List Geofences
|
|
795
|
+
|
|
796
|
+
Get user's polygon geofences.
|
|
797
|
+
|
|
798
|
+
### Example
|
|
799
|
+
|
|
800
|
+
* Api Key Authentication (APIKeyBearer):
|
|
801
|
+
* Bearer Authentication (JWTBearer):
|
|
802
|
+
|
|
803
|
+
```python
|
|
804
|
+
import spatialflow_generated
|
|
805
|
+
from spatialflow_generated.models.geofence_list_response import GeofenceListResponse
|
|
806
|
+
from spatialflow_generated.rest import ApiException
|
|
807
|
+
from pprint import pprint
|
|
808
|
+
|
|
809
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
810
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
811
|
+
configuration = spatialflow_generated.Configuration(
|
|
812
|
+
host = "https://api.spatialflow.io"
|
|
813
|
+
)
|
|
814
|
+
|
|
815
|
+
# The client must configure the authentication and authorization parameters
|
|
816
|
+
# in accordance with the API server security policy.
|
|
817
|
+
# Examples for each auth method are provided below, use the example that
|
|
818
|
+
# satisfies your auth use case.
|
|
819
|
+
|
|
820
|
+
# Configure API key authorization: APIKeyBearer
|
|
821
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
822
|
+
|
|
823
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
824
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
825
|
+
|
|
826
|
+
# Configure Bearer authorization: JWTBearer
|
|
827
|
+
configuration = spatialflow_generated.Configuration(
|
|
828
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
829
|
+
)
|
|
830
|
+
|
|
831
|
+
# Enter a context with an instance of the API client
|
|
832
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
833
|
+
# Create an instance of the API class
|
|
834
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
835
|
+
limit = 50 # int | (optional) (default to 50)
|
|
836
|
+
offset = 0 # int | (optional) (default to 0)
|
|
837
|
+
active_only = True # bool | (optional) (default to True)
|
|
838
|
+
|
|
839
|
+
try:
|
|
840
|
+
# List Geofences
|
|
841
|
+
api_response = await api_instance.apps_geofences_api_list_geofences(limit=limit, offset=offset, active_only=active_only)
|
|
842
|
+
print("The response of GeofencesApi->apps_geofences_api_list_geofences:\n")
|
|
843
|
+
pprint(api_response)
|
|
844
|
+
except Exception as e:
|
|
845
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_list_geofences: %s\n" % e)
|
|
846
|
+
```
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
### Parameters
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
Name | Type | Description | Notes
|
|
854
|
+
------------- | ------------- | ------------- | -------------
|
|
855
|
+
**limit** | **int**| | [optional] [default to 50]
|
|
856
|
+
**offset** | **int**| | [optional] [default to 0]
|
|
857
|
+
**active_only** | **bool**| | [optional] [default to True]
|
|
858
|
+
|
|
859
|
+
### Return type
|
|
860
|
+
|
|
861
|
+
[**GeofenceListResponse**](GeofenceListResponse.md)
|
|
862
|
+
|
|
863
|
+
### Authorization
|
|
864
|
+
|
|
865
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
866
|
+
|
|
867
|
+
### HTTP request headers
|
|
868
|
+
|
|
869
|
+
- **Content-Type**: Not defined
|
|
870
|
+
- **Accept**: application/json
|
|
871
|
+
|
|
872
|
+
### HTTP response details
|
|
873
|
+
|
|
874
|
+
| Status code | Description | Response headers |
|
|
875
|
+
|-------------|-------------|------------------|
|
|
876
|
+
**200** | OK | - |
|
|
877
|
+
**401** | Unauthorized | - |
|
|
878
|
+
**429** | Too Many Requests | - |
|
|
879
|
+
**500** | Internal Server Error | - |
|
|
880
|
+
**501** | Not Implemented | - |
|
|
881
|
+
**502** | Bad Gateway | - |
|
|
882
|
+
**503** | Service Unavailable | - |
|
|
883
|
+
**504** | Gateway Timeout | - |
|
|
884
|
+
|
|
885
|
+
[[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)
|
|
886
|
+
|
|
887
|
+
# **apps_geofences_api_list_group_geofences**
|
|
888
|
+
> Dict[str, object] apps_geofences_api_list_group_geofences(group_id)
|
|
889
|
+
|
|
890
|
+
List Group Geofences
|
|
891
|
+
|
|
892
|
+
List all geofences in a specific group.
|
|
893
|
+
|
|
894
|
+
### Example
|
|
895
|
+
|
|
896
|
+
* Api Key Authentication (APIKeyBearer):
|
|
897
|
+
* Bearer Authentication (JWTBearer):
|
|
898
|
+
|
|
899
|
+
```python
|
|
900
|
+
import spatialflow_generated
|
|
901
|
+
from spatialflow_generated.rest import ApiException
|
|
902
|
+
from pprint import pprint
|
|
903
|
+
|
|
904
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
905
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
906
|
+
configuration = spatialflow_generated.Configuration(
|
|
907
|
+
host = "https://api.spatialflow.io"
|
|
908
|
+
)
|
|
909
|
+
|
|
910
|
+
# The client must configure the authentication and authorization parameters
|
|
911
|
+
# in accordance with the API server security policy.
|
|
912
|
+
# Examples for each auth method are provided below, use the example that
|
|
913
|
+
# satisfies your auth use case.
|
|
914
|
+
|
|
915
|
+
# Configure API key authorization: APIKeyBearer
|
|
916
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
917
|
+
|
|
918
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
919
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
920
|
+
|
|
921
|
+
# Configure Bearer authorization: JWTBearer
|
|
922
|
+
configuration = spatialflow_generated.Configuration(
|
|
923
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
924
|
+
)
|
|
925
|
+
|
|
926
|
+
# Enter a context with an instance of the API client
|
|
927
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
928
|
+
# Create an instance of the API class
|
|
929
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
930
|
+
group_id = 'group_id_example' # str |
|
|
931
|
+
|
|
932
|
+
try:
|
|
933
|
+
# List Group Geofences
|
|
934
|
+
api_response = await api_instance.apps_geofences_api_list_group_geofences(group_id)
|
|
935
|
+
print("The response of GeofencesApi->apps_geofences_api_list_group_geofences:\n")
|
|
936
|
+
pprint(api_response)
|
|
937
|
+
except Exception as e:
|
|
938
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_list_group_geofences: %s\n" % e)
|
|
939
|
+
```
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
### Parameters
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
Name | Type | Description | Notes
|
|
947
|
+
------------- | ------------- | ------------- | -------------
|
|
948
|
+
**group_id** | **str**| |
|
|
949
|
+
|
|
950
|
+
### Return type
|
|
951
|
+
|
|
952
|
+
**Dict[str, object]**
|
|
953
|
+
|
|
954
|
+
### Authorization
|
|
955
|
+
|
|
956
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
957
|
+
|
|
958
|
+
### HTTP request headers
|
|
959
|
+
|
|
960
|
+
- **Content-Type**: Not defined
|
|
961
|
+
- **Accept**: application/json
|
|
962
|
+
|
|
963
|
+
### HTTP response details
|
|
964
|
+
|
|
965
|
+
| Status code | Description | Response headers |
|
|
966
|
+
|-------------|-------------|------------------|
|
|
967
|
+
**200** | OK | - |
|
|
968
|
+
|
|
969
|
+
[[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)
|
|
970
|
+
|
|
971
|
+
# **apps_geofences_api_test_group_point**
|
|
972
|
+
> Dict[str, object] apps_geofences_api_test_group_point(group_id, test_point_request)
|
|
973
|
+
|
|
974
|
+
Test Group Point
|
|
975
|
+
|
|
976
|
+
Test a point against all geofences in a group.
|
|
977
|
+
|
|
978
|
+
### Example
|
|
979
|
+
|
|
980
|
+
* Api Key Authentication (APIKeyBearer):
|
|
981
|
+
* Bearer Authentication (JWTBearer):
|
|
982
|
+
|
|
983
|
+
```python
|
|
984
|
+
import spatialflow_generated
|
|
985
|
+
from spatialflow_generated.models.test_point_request import TestPointRequest
|
|
986
|
+
from spatialflow_generated.rest import ApiException
|
|
987
|
+
from pprint import pprint
|
|
988
|
+
|
|
989
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
990
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
991
|
+
configuration = spatialflow_generated.Configuration(
|
|
992
|
+
host = "https://api.spatialflow.io"
|
|
993
|
+
)
|
|
994
|
+
|
|
995
|
+
# The client must configure the authentication and authorization parameters
|
|
996
|
+
# in accordance with the API server security policy.
|
|
997
|
+
# Examples for each auth method are provided below, use the example that
|
|
998
|
+
# satisfies your auth use case.
|
|
999
|
+
|
|
1000
|
+
# Configure API key authorization: APIKeyBearer
|
|
1001
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1002
|
+
|
|
1003
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1004
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1005
|
+
|
|
1006
|
+
# Configure Bearer authorization: JWTBearer
|
|
1007
|
+
configuration = spatialflow_generated.Configuration(
|
|
1008
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1009
|
+
)
|
|
1010
|
+
|
|
1011
|
+
# Enter a context with an instance of the API client
|
|
1012
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1013
|
+
# Create an instance of the API class
|
|
1014
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
1015
|
+
group_id = 'group_id_example' # str |
|
|
1016
|
+
test_point_request = spatialflow_generated.TestPointRequest() # TestPointRequest |
|
|
1017
|
+
|
|
1018
|
+
try:
|
|
1019
|
+
# Test Group Point
|
|
1020
|
+
api_response = await api_instance.apps_geofences_api_test_group_point(group_id, test_point_request)
|
|
1021
|
+
print("The response of GeofencesApi->apps_geofences_api_test_group_point:\n")
|
|
1022
|
+
pprint(api_response)
|
|
1023
|
+
except Exception as e:
|
|
1024
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_test_group_point: %s\n" % e)
|
|
1025
|
+
```
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
### Parameters
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
Name | Type | Description | Notes
|
|
1033
|
+
------------- | ------------- | ------------- | -------------
|
|
1034
|
+
**group_id** | **str**| |
|
|
1035
|
+
**test_point_request** | [**TestPointRequest**](TestPointRequest.md)| |
|
|
1036
|
+
|
|
1037
|
+
### Return type
|
|
1038
|
+
|
|
1039
|
+
**Dict[str, object]**
|
|
1040
|
+
|
|
1041
|
+
### Authorization
|
|
1042
|
+
|
|
1043
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1044
|
+
|
|
1045
|
+
### HTTP request headers
|
|
1046
|
+
|
|
1047
|
+
- **Content-Type**: application/json
|
|
1048
|
+
- **Accept**: application/json
|
|
1049
|
+
|
|
1050
|
+
### HTTP response details
|
|
1051
|
+
|
|
1052
|
+
| Status code | Description | Response headers |
|
|
1053
|
+
|-------------|-------------|------------------|
|
|
1054
|
+
**200** | OK | - |
|
|
1055
|
+
|
|
1056
|
+
[[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)
|
|
1057
|
+
|
|
1058
|
+
# **apps_geofences_api_test_point**
|
|
1059
|
+
> TestPointResponse apps_geofences_api_test_point(test_point_request)
|
|
1060
|
+
|
|
1061
|
+
Test Point
|
|
1062
|
+
|
|
1063
|
+
Test a point against user's geofences.
|
|
1064
|
+
|
|
1065
|
+
### Example
|
|
1066
|
+
|
|
1067
|
+
* Api Key Authentication (APIKeyBearer):
|
|
1068
|
+
* Bearer Authentication (JWTBearer):
|
|
1069
|
+
|
|
1070
|
+
```python
|
|
1071
|
+
import spatialflow_generated
|
|
1072
|
+
from spatialflow_generated.models.test_point_request import TestPointRequest
|
|
1073
|
+
from spatialflow_generated.models.test_point_response import TestPointResponse
|
|
1074
|
+
from spatialflow_generated.rest import ApiException
|
|
1075
|
+
from pprint import pprint
|
|
1076
|
+
|
|
1077
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1078
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1079
|
+
configuration = spatialflow_generated.Configuration(
|
|
1080
|
+
host = "https://api.spatialflow.io"
|
|
1081
|
+
)
|
|
1082
|
+
|
|
1083
|
+
# The client must configure the authentication and authorization parameters
|
|
1084
|
+
# in accordance with the API server security policy.
|
|
1085
|
+
# Examples for each auth method are provided below, use the example that
|
|
1086
|
+
# satisfies your auth use case.
|
|
1087
|
+
|
|
1088
|
+
# Configure API key authorization: APIKeyBearer
|
|
1089
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1090
|
+
|
|
1091
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1092
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1093
|
+
|
|
1094
|
+
# Configure Bearer authorization: JWTBearer
|
|
1095
|
+
configuration = spatialflow_generated.Configuration(
|
|
1096
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1097
|
+
)
|
|
1098
|
+
|
|
1099
|
+
# Enter a context with an instance of the API client
|
|
1100
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1101
|
+
# Create an instance of the API class
|
|
1102
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
1103
|
+
test_point_request = spatialflow_generated.TestPointRequest() # TestPointRequest |
|
|
1104
|
+
|
|
1105
|
+
try:
|
|
1106
|
+
# Test Point
|
|
1107
|
+
api_response = await api_instance.apps_geofences_api_test_point(test_point_request)
|
|
1108
|
+
print("The response of GeofencesApi->apps_geofences_api_test_point:\n")
|
|
1109
|
+
pprint(api_response)
|
|
1110
|
+
except Exception as e:
|
|
1111
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_test_point: %s\n" % e)
|
|
1112
|
+
```
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
### Parameters
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
Name | Type | Description | Notes
|
|
1120
|
+
------------- | ------------- | ------------- | -------------
|
|
1121
|
+
**test_point_request** | [**TestPointRequest**](TestPointRequest.md)| |
|
|
1122
|
+
|
|
1123
|
+
### Return type
|
|
1124
|
+
|
|
1125
|
+
[**TestPointResponse**](TestPointResponse.md)
|
|
1126
|
+
|
|
1127
|
+
### Authorization
|
|
1128
|
+
|
|
1129
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1130
|
+
|
|
1131
|
+
### HTTP request headers
|
|
1132
|
+
|
|
1133
|
+
- **Content-Type**: application/json
|
|
1134
|
+
- **Accept**: application/json
|
|
1135
|
+
|
|
1136
|
+
### HTTP response details
|
|
1137
|
+
|
|
1138
|
+
| Status code | Description | Response headers |
|
|
1139
|
+
|-------------|-------------|------------------|
|
|
1140
|
+
**200** | OK | - |
|
|
1141
|
+
**400** | Bad Request | - |
|
|
1142
|
+
**401** | Unauthorized | - |
|
|
1143
|
+
**429** | Too Many Requests | - |
|
|
1144
|
+
**500** | Internal Server Error | - |
|
|
1145
|
+
**501** | Not Implemented | - |
|
|
1146
|
+
**502** | Bad Gateway | - |
|
|
1147
|
+
**503** | Service Unavailable | - |
|
|
1148
|
+
**504** | Gateway Timeout | - |
|
|
1149
|
+
|
|
1150
|
+
[[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)
|
|
1151
|
+
|
|
1152
|
+
# **apps_geofences_api_trigger_test_event**
|
|
1153
|
+
> Dict[str, object] apps_geofences_api_trigger_test_event(geofence_id, event_type, test_event_request=test_event_request)
|
|
1154
|
+
|
|
1155
|
+
Trigger Test Event
|
|
1156
|
+
|
|
1157
|
+
Trigger a simulated test event for a geofence. This allows users to test their webhooks and workflows without physically entering or exiting the geofence. Args: geofence_id: ID of the geofence event_type: Type of event to simulate ('enter' or 'exit') test_metadata: Optional metadata to include in the test event Returns: Test event details including triggered webhooks and workflows
|
|
1158
|
+
|
|
1159
|
+
### Example
|
|
1160
|
+
|
|
1161
|
+
* Api Key Authentication (APIKeyBearer):
|
|
1162
|
+
* Bearer Authentication (JWTBearer):
|
|
1163
|
+
|
|
1164
|
+
```python
|
|
1165
|
+
import spatialflow_generated
|
|
1166
|
+
from spatialflow_generated.models.test_event_request import TestEventRequest
|
|
1167
|
+
from spatialflow_generated.rest import ApiException
|
|
1168
|
+
from pprint import pprint
|
|
1169
|
+
|
|
1170
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1171
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1172
|
+
configuration = spatialflow_generated.Configuration(
|
|
1173
|
+
host = "https://api.spatialflow.io"
|
|
1174
|
+
)
|
|
1175
|
+
|
|
1176
|
+
# The client must configure the authentication and authorization parameters
|
|
1177
|
+
# in accordance with the API server security policy.
|
|
1178
|
+
# Examples for each auth method are provided below, use the example that
|
|
1179
|
+
# satisfies your auth use case.
|
|
1180
|
+
|
|
1181
|
+
# Configure API key authorization: APIKeyBearer
|
|
1182
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1183
|
+
|
|
1184
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1185
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1186
|
+
|
|
1187
|
+
# Configure Bearer authorization: JWTBearer
|
|
1188
|
+
configuration = spatialflow_generated.Configuration(
|
|
1189
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1190
|
+
)
|
|
1191
|
+
|
|
1192
|
+
# Enter a context with an instance of the API client
|
|
1193
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1194
|
+
# Create an instance of the API class
|
|
1195
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
1196
|
+
geofence_id = 'geofence_id_example' # str |
|
|
1197
|
+
event_type = 'event_type_example' # str |
|
|
1198
|
+
test_event_request = spatialflow_generated.TestEventRequest() # TestEventRequest | (optional)
|
|
1199
|
+
|
|
1200
|
+
try:
|
|
1201
|
+
# Trigger Test Event
|
|
1202
|
+
api_response = await api_instance.apps_geofences_api_trigger_test_event(geofence_id, event_type, test_event_request=test_event_request)
|
|
1203
|
+
print("The response of GeofencesApi->apps_geofences_api_trigger_test_event:\n")
|
|
1204
|
+
pprint(api_response)
|
|
1205
|
+
except Exception as e:
|
|
1206
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_trigger_test_event: %s\n" % e)
|
|
1207
|
+
```
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
### Parameters
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
Name | Type | Description | Notes
|
|
1215
|
+
------------- | ------------- | ------------- | -------------
|
|
1216
|
+
**geofence_id** | **str**| |
|
|
1217
|
+
**event_type** | **str**| |
|
|
1218
|
+
**test_event_request** | [**TestEventRequest**](TestEventRequest.md)| | [optional]
|
|
1219
|
+
|
|
1220
|
+
### Return type
|
|
1221
|
+
|
|
1222
|
+
**Dict[str, object]**
|
|
1223
|
+
|
|
1224
|
+
### Authorization
|
|
1225
|
+
|
|
1226
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1227
|
+
|
|
1228
|
+
### HTTP request headers
|
|
1229
|
+
|
|
1230
|
+
- **Content-Type**: application/json
|
|
1231
|
+
- **Accept**: application/json
|
|
1232
|
+
|
|
1233
|
+
### HTTP response details
|
|
1234
|
+
|
|
1235
|
+
| Status code | Description | Response headers |
|
|
1236
|
+
|-------------|-------------|------------------|
|
|
1237
|
+
**200** | OK | - |
|
|
1238
|
+
**400** | Bad Request | - |
|
|
1239
|
+
**401** | Unauthorized | - |
|
|
1240
|
+
**404** | Not Found | - |
|
|
1241
|
+
**500** | Internal Server Error | - |
|
|
1242
|
+
**501** | Not Implemented | - |
|
|
1243
|
+
**502** | Bad Gateway | - |
|
|
1244
|
+
**503** | Service Unavailable | - |
|
|
1245
|
+
**504** | Gateway Timeout | - |
|
|
1246
|
+
|
|
1247
|
+
[[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)
|
|
1248
|
+
|
|
1249
|
+
# **apps_geofences_api_update_geofence**
|
|
1250
|
+
> GeofenceResponse apps_geofences_api_update_geofence(geofence_id, update_geofence_request)
|
|
1251
|
+
|
|
1252
|
+
Update Geofence
|
|
1253
|
+
|
|
1254
|
+
Update existing polygon geofence.
|
|
1255
|
+
|
|
1256
|
+
### Example
|
|
1257
|
+
|
|
1258
|
+
* Api Key Authentication (APIKeyBearer):
|
|
1259
|
+
* Bearer Authentication (JWTBearer):
|
|
1260
|
+
|
|
1261
|
+
```python
|
|
1262
|
+
import spatialflow_generated
|
|
1263
|
+
from spatialflow_generated.models.geofence_response import GeofenceResponse
|
|
1264
|
+
from spatialflow_generated.models.update_geofence_request import UpdateGeofenceRequest
|
|
1265
|
+
from spatialflow_generated.rest import ApiException
|
|
1266
|
+
from pprint import pprint
|
|
1267
|
+
|
|
1268
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1269
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1270
|
+
configuration = spatialflow_generated.Configuration(
|
|
1271
|
+
host = "https://api.spatialflow.io"
|
|
1272
|
+
)
|
|
1273
|
+
|
|
1274
|
+
# The client must configure the authentication and authorization parameters
|
|
1275
|
+
# in accordance with the API server security policy.
|
|
1276
|
+
# Examples for each auth method are provided below, use the example that
|
|
1277
|
+
# satisfies your auth use case.
|
|
1278
|
+
|
|
1279
|
+
# Configure API key authorization: APIKeyBearer
|
|
1280
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1281
|
+
|
|
1282
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1283
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1284
|
+
|
|
1285
|
+
# Configure Bearer authorization: JWTBearer
|
|
1286
|
+
configuration = spatialflow_generated.Configuration(
|
|
1287
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1288
|
+
)
|
|
1289
|
+
|
|
1290
|
+
# Enter a context with an instance of the API client
|
|
1291
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1292
|
+
# Create an instance of the API class
|
|
1293
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
1294
|
+
geofence_id = 'geofence_id_example' # str |
|
|
1295
|
+
update_geofence_request = spatialflow_generated.UpdateGeofenceRequest() # UpdateGeofenceRequest |
|
|
1296
|
+
|
|
1297
|
+
try:
|
|
1298
|
+
# Update Geofence
|
|
1299
|
+
api_response = await api_instance.apps_geofences_api_update_geofence(geofence_id, update_geofence_request)
|
|
1300
|
+
print("The response of GeofencesApi->apps_geofences_api_update_geofence:\n")
|
|
1301
|
+
pprint(api_response)
|
|
1302
|
+
except Exception as e:
|
|
1303
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_update_geofence: %s\n" % e)
|
|
1304
|
+
```
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
### Parameters
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
Name | Type | Description | Notes
|
|
1312
|
+
------------- | ------------- | ------------- | -------------
|
|
1313
|
+
**geofence_id** | **str**| |
|
|
1314
|
+
**update_geofence_request** | [**UpdateGeofenceRequest**](UpdateGeofenceRequest.md)| |
|
|
1315
|
+
|
|
1316
|
+
### Return type
|
|
1317
|
+
|
|
1318
|
+
[**GeofenceResponse**](GeofenceResponse.md)
|
|
1319
|
+
|
|
1320
|
+
### Authorization
|
|
1321
|
+
|
|
1322
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1323
|
+
|
|
1324
|
+
### HTTP request headers
|
|
1325
|
+
|
|
1326
|
+
- **Content-Type**: application/json
|
|
1327
|
+
- **Accept**: application/json
|
|
1328
|
+
|
|
1329
|
+
### HTTP response details
|
|
1330
|
+
|
|
1331
|
+
| Status code | Description | Response headers |
|
|
1332
|
+
|-------------|-------------|------------------|
|
|
1333
|
+
**200** | OK | - |
|
|
1334
|
+
**400** | Bad Request | - |
|
|
1335
|
+
**401** | Unauthorized | - |
|
|
1336
|
+
**404** | Not Found | - |
|
|
1337
|
+
**500** | Internal Server Error | - |
|
|
1338
|
+
**501** | Not Implemented | - |
|
|
1339
|
+
**502** | Bad Gateway | - |
|
|
1340
|
+
**503** | Service Unavailable | - |
|
|
1341
|
+
**504** | Gateway Timeout | - |
|
|
1342
|
+
|
|
1343
|
+
[[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)
|
|
1344
|
+
|
|
1345
|
+
# **apps_geofences_api_update_geofence_group**
|
|
1346
|
+
> Dict[str, object] apps_geofences_api_update_geofence_group(geofence_id, group_name=group_name)
|
|
1347
|
+
|
|
1348
|
+
Update Geofence Group
|
|
1349
|
+
|
|
1350
|
+
Assign or update a geofence's group.
|
|
1351
|
+
|
|
1352
|
+
### Example
|
|
1353
|
+
|
|
1354
|
+
* Api Key Authentication (APIKeyBearer):
|
|
1355
|
+
* Bearer Authentication (JWTBearer):
|
|
1356
|
+
|
|
1357
|
+
```python
|
|
1358
|
+
import spatialflow_generated
|
|
1359
|
+
from spatialflow_generated.rest import ApiException
|
|
1360
|
+
from pprint import pprint
|
|
1361
|
+
|
|
1362
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1363
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1364
|
+
configuration = spatialflow_generated.Configuration(
|
|
1365
|
+
host = "https://api.spatialflow.io"
|
|
1366
|
+
)
|
|
1367
|
+
|
|
1368
|
+
# The client must configure the authentication and authorization parameters
|
|
1369
|
+
# in accordance with the API server security policy.
|
|
1370
|
+
# Examples for each auth method are provided below, use the example that
|
|
1371
|
+
# satisfies your auth use case.
|
|
1372
|
+
|
|
1373
|
+
# Configure API key authorization: APIKeyBearer
|
|
1374
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1375
|
+
|
|
1376
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1377
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1378
|
+
|
|
1379
|
+
# Configure Bearer authorization: JWTBearer
|
|
1380
|
+
configuration = spatialflow_generated.Configuration(
|
|
1381
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1382
|
+
)
|
|
1383
|
+
|
|
1384
|
+
# Enter a context with an instance of the API client
|
|
1385
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1386
|
+
# Create an instance of the API class
|
|
1387
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
1388
|
+
geofence_id = 'geofence_id_example' # str |
|
|
1389
|
+
group_name = 'group_name_example' # str | (optional)
|
|
1390
|
+
|
|
1391
|
+
try:
|
|
1392
|
+
# Update Geofence Group
|
|
1393
|
+
api_response = await api_instance.apps_geofences_api_update_geofence_group(geofence_id, group_name=group_name)
|
|
1394
|
+
print("The response of GeofencesApi->apps_geofences_api_update_geofence_group:\n")
|
|
1395
|
+
pprint(api_response)
|
|
1396
|
+
except Exception as e:
|
|
1397
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_update_geofence_group: %s\n" % e)
|
|
1398
|
+
```
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
### Parameters
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
Name | Type | Description | Notes
|
|
1406
|
+
------------- | ------------- | ------------- | -------------
|
|
1407
|
+
**geofence_id** | **str**| |
|
|
1408
|
+
**group_name** | **str**| | [optional]
|
|
1409
|
+
|
|
1410
|
+
### Return type
|
|
1411
|
+
|
|
1412
|
+
**Dict[str, object]**
|
|
1413
|
+
|
|
1414
|
+
### Authorization
|
|
1415
|
+
|
|
1416
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1417
|
+
|
|
1418
|
+
### HTTP request headers
|
|
1419
|
+
|
|
1420
|
+
- **Content-Type**: Not defined
|
|
1421
|
+
- **Accept**: application/json
|
|
1422
|
+
|
|
1423
|
+
### HTTP response details
|
|
1424
|
+
|
|
1425
|
+
| Status code | Description | Response headers |
|
|
1426
|
+
|-------------|-------------|------------------|
|
|
1427
|
+
**200** | OK | - |
|
|
1428
|
+
|
|
1429
|
+
[[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)
|
|
1430
|
+
|
|
1431
|
+
# **apps_geofences_api_upload_geofences_async**
|
|
1432
|
+
> AsyncUploadGeofencesResponse apps_geofences_api_upload_geofences_async(upload_geofences_request)
|
|
1433
|
+
|
|
1434
|
+
Upload Geofences Async
|
|
1435
|
+
|
|
1436
|
+
Upload geofences from a file (asynchronous). This endpoint queues a background job to process geofence imports from various file formats: - GeoJSON (.geojson, .json) - Standard geospatial format - KML (.kml) - Google Earth format - GPX (.gpx) - GPS track format (converted to polygon buffers) The file must first be uploaded using the storage API to get a file_id. All imported geofences can optionally be assigned to a group. Returns a job ID to track the import progress.
|
|
1437
|
+
|
|
1438
|
+
### Example
|
|
1439
|
+
|
|
1440
|
+
* Api Key Authentication (APIKeyBearer):
|
|
1441
|
+
* Bearer Authentication (JWTBearer):
|
|
1442
|
+
|
|
1443
|
+
```python
|
|
1444
|
+
import spatialflow_generated
|
|
1445
|
+
from spatialflow_generated.models.async_upload_geofences_response import AsyncUploadGeofencesResponse
|
|
1446
|
+
from spatialflow_generated.models.upload_geofences_request import UploadGeofencesRequest
|
|
1447
|
+
from spatialflow_generated.rest import ApiException
|
|
1448
|
+
from pprint import pprint
|
|
1449
|
+
|
|
1450
|
+
# Defining the host is optional and defaults to https://api.spatialflow.io
|
|
1451
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
1452
|
+
configuration = spatialflow_generated.Configuration(
|
|
1453
|
+
host = "https://api.spatialflow.io"
|
|
1454
|
+
)
|
|
1455
|
+
|
|
1456
|
+
# The client must configure the authentication and authorization parameters
|
|
1457
|
+
# in accordance with the API server security policy.
|
|
1458
|
+
# Examples for each auth method are provided below, use the example that
|
|
1459
|
+
# satisfies your auth use case.
|
|
1460
|
+
|
|
1461
|
+
# Configure API key authorization: APIKeyBearer
|
|
1462
|
+
configuration.api_key['APIKeyBearer'] = os.environ["API_KEY"]
|
|
1463
|
+
|
|
1464
|
+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
1465
|
+
# configuration.api_key_prefix['APIKeyBearer'] = 'Bearer'
|
|
1466
|
+
|
|
1467
|
+
# Configure Bearer authorization: JWTBearer
|
|
1468
|
+
configuration = spatialflow_generated.Configuration(
|
|
1469
|
+
access_token = os.environ["BEARER_TOKEN"]
|
|
1470
|
+
)
|
|
1471
|
+
|
|
1472
|
+
# Enter a context with an instance of the API client
|
|
1473
|
+
async with spatialflow_generated.ApiClient(configuration) as api_client:
|
|
1474
|
+
# Create an instance of the API class
|
|
1475
|
+
api_instance = spatialflow_generated.GeofencesApi(api_client)
|
|
1476
|
+
upload_geofences_request = spatialflow_generated.UploadGeofencesRequest() # UploadGeofencesRequest |
|
|
1477
|
+
|
|
1478
|
+
try:
|
|
1479
|
+
# Upload Geofences Async
|
|
1480
|
+
api_response = await api_instance.apps_geofences_api_upload_geofences_async(upload_geofences_request)
|
|
1481
|
+
print("The response of GeofencesApi->apps_geofences_api_upload_geofences_async:\n")
|
|
1482
|
+
pprint(api_response)
|
|
1483
|
+
except Exception as e:
|
|
1484
|
+
print("Exception when calling GeofencesApi->apps_geofences_api_upload_geofences_async: %s\n" % e)
|
|
1485
|
+
```
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
### Parameters
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
Name | Type | Description | Notes
|
|
1493
|
+
------------- | ------------- | ------------- | -------------
|
|
1494
|
+
**upload_geofences_request** | [**UploadGeofencesRequest**](UploadGeofencesRequest.md)| |
|
|
1495
|
+
|
|
1496
|
+
### Return type
|
|
1497
|
+
|
|
1498
|
+
[**AsyncUploadGeofencesResponse**](AsyncUploadGeofencesResponse.md)
|
|
1499
|
+
|
|
1500
|
+
### Authorization
|
|
1501
|
+
|
|
1502
|
+
[APIKeyBearer](../README.md#APIKeyBearer), [JWTBearer](../README.md#JWTBearer)
|
|
1503
|
+
|
|
1504
|
+
### HTTP request headers
|
|
1505
|
+
|
|
1506
|
+
- **Content-Type**: application/json
|
|
1507
|
+
- **Accept**: application/json
|
|
1508
|
+
|
|
1509
|
+
### HTTP response details
|
|
1510
|
+
|
|
1511
|
+
| Status code | Description | Response headers |
|
|
1512
|
+
|-------------|-------------|------------------|
|
|
1513
|
+
**202** | Accepted | - |
|
|
1514
|
+
**400** | Bad Request | - |
|
|
1515
|
+
**401** | Unauthorized | - |
|
|
1516
|
+
**429** | Too Many Requests | - |
|
|
1517
|
+
**500** | Internal Server Error | - |
|
|
1518
|
+
**501** | Not Implemented | - |
|
|
1519
|
+
**502** | Bad Gateway | - |
|
|
1520
|
+
**503** | Service Unavailable | - |
|
|
1521
|
+
**504** | Gateway Timeout | - |
|
|
1522
|
+
|
|
1523
|
+
[[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)
|
|
1524
|
+
|