Module: OpenapiClient

Defined in:
lib/openapi_client/version.rb,
lib/openapi_client.rb,
lib/openapi_client/api_error.rb,
lib/openapi_client/api_client.rb,
lib/openapi_client/api/sso_api.rb,
lib/openapi_client/models/team.rb,
lib/openapi_client/api/auth_api.rb,
lib/openapi_client/models/error.rb,
lib/openapi_client/api/admin_api.rb,
lib/openapi_client/api/embed_api.rb,
lib/openapi_client/api/stats_api.rb,
lib/openapi_client/api/teams_api.rb,
lib/openapi_client/configuration.rb,
lib/openapi_client/api/alerts_api.rb,
lib/openapi_client/api/events_api.rb,
lib/openapi_client/api/health_api.rb,
lib/openapi_client/api/o_auth_api.rb,
lib/openapi_client/api/search_api.rb,
lib/openapi_client/api/stream_api.rb,
lib/openapi_client/api_model_base.rb,
lib/openapi_client/api/billing_api.rb,
lib/openapi_client/api/contact_api.rb,
lib/openapi_client/api/devices_api.rb,
lib/openapi_client/api/inbound_api.rb,
lib/openapi_client/api/routing_api.rb,
lib/openapi_client/api/schemas_api.rb,
lib/openapi_client/models/delivery.rb,
lib/openapi_client/models/endpoint.rb,
lib/openapi_client/api/api_keys_api.rb,
lib/openapi_client/api/webhooks_api.rb,
lib/openapi_client/api/analytics_api.rb,
lib/openapi_client/api/audit_log_api.rb,
lib/openapi_client/api/endpoints_api.rb,
lib/openapi_client/api/simulator_api.rb,
lib/openapi_client/api/templates_api.rb,
lib/openapi_client/models/alert_rule.rb,
lib/openapi_client/api/playground_api.rb,
lib/openapi_client/api/transforms_api.rb,
lib/openapi_client/models/team_invite.rb,
lib/openapi_client/models/team_member.rb,
lib/openapi_client/api/rate_limits_api.rb,
lib/openapi_client/models/api_key_info.rb,
lib/openapi_client/models/notification.rb,
lib/openapi_client/models/retry_policy.rb,
lib/openapi_client/models/routing_info.rb,
lib/openapi_client/models/system_stats.rb,
lib/openapi_client/models/user_summary.rb,
lib/openapi_client/api/outbound_ips_api.rb,
lib/openapi_client/models/auth_response.rb,
lib/openapi_client/models/login_request.rb,
lib/openapi_client/models/search_result.rb,
lib/openapi_client/models/stream_params.rb,
lib/openapi_client/models/system_status.rb,
lib/openapi_client/api/notifications_api.rb,
lib/openapi_client/models/batch_response.rb,
lib/openapi_client/models/invite_request.rb,
lib/openapi_client/models/portal_profile.rb,
lib/openapi_client/models/stats_response.rb,
lib/openapi_client/models/transform_rule.rb,
lib/openapi_client/models/usage_response.rb,
lib/openapi_client/api/custom_domains_api.rb,
lib/openapi_client/models/contact_request.rb,
lib/openapi_client/models/endpoint_health.rb,
lib/openapi_client/models/paginated_users.rb,
lib/openapi_client/models/upgrade_request.rb,
lib/openapi_client/api/customer_portal_api.rb,
lib/openapi_client/models/contact_response.rb,
lib/openapi_client/models/delivery_attempt.rb,
lib/openapi_client/models/invoice_response.rb,
lib/openapi_client/models/register_request.rb,
lib/openapi_client/models/upgrade_response.rb,
lib/openapi_client/models/webhook_template.rb,
lib/openapi_client/api/delivery_details_api.rb,
lib/openapi_client/models/customer_response.rb,
lib/openapi_client/models/enable2fa_request.rb,
lib/openapi_client/models/verify2fa_request.rb,
lib/openapi_client/models/confirm2fa_request.rb,
lib/openapi_client/models/disable2fa_request.rb,
lib/openapi_client/models/change_role_request.rb,
lib/openapi_client/models/create_team_request.rb,
lib/openapi_client/models/batch_replay_request.rb,
lib/openapi_client/models/create_alert_request.rb,
lib/openapi_client/models/team_detail_response.rb,
lib/openapi_client/models/test_webhook_request.rb,
lib/openapi_client/models/verify_email_request.rb,
lib/openapi_client/models/batch_webhook_request.rb,
lib/openapi_client/models/device_token_response.rb,
lib/openapi_client/models/outbound_ips_response.rb,
lib/openapi_client/models/refresh_token_request.rb,
lib/openapi_client/models/subscription_response.rb,
lib/openapi_client/models/success_rate_response.rb,
lib/openapi_client/models/test_webhook_response.rb,
lib/openapi_client/models/apply_template_request.rb,
lib/openapi_client/models/create_webhook_request.rb,
lib/openapi_client/models/delivery_list_response.rb,
lib/openapi_client/models/latency_trend_response.rb,
lib/openapi_client/models/reset_password_request.rb,
lib/openapi_client/models/simulator_post_request.rb,
lib/openapi_client/models/update_profile_request.rb,
lib/openapi_client/models/update_routing_request.rb,
lib/openapi_client/models/validate_event_request.rb,
lib/openapi_client/models/apply_template_response.rb,
lib/openapi_client/models/change_password_request.rb,
lib/openapi_client/models/create_api_key_response.rb,
lib/openapi_client/models/create_endpoint_request.rb,
lib/openapi_client/models/delivery_trend_response.rb,
lib/openapi_client/models/forgot_password_request.rb,
lib/openapi_client/models/register_device_request.rb,
lib/openapi_client/models/register_schema_request.rb,
lib/openapi_client/models/sso_config_post_request.rb,
lib/openapi_client/models/update_endpoint_request.rb,
lib/openapi_client/models/notification_preferences.rb,
lib/openapi_client/models/notification_list_response.rb,
lib/openapi_client/models/playground_get200_response.rb,
lib/openapi_client/models/auth_login_post200_response.rb,
lib/openapi_client/models/batch_response_errors_inner.rb,
lib/openapi_client/models/custom_domains_post_request.rb,
lib/openapi_client/models/resend_verification_request.rb,
lib/openapi_client/models/two_factor_required_response.rb,
lib/openapi_client/models/admin_sdk_update_post_request.rb,
lib/openapi_client/models/create_transform_rule_request.rb,
lib/openapi_client/models/system_status_components_inner.rb,
lib/openapi_client/models/admin_users_id_plan_put_request.rb,
lib/openapi_client/models/auth2fa_enable_post200_response.rb,
lib/openapi_client/models/billing_portal_post200_response.rb,
lib/openapi_client/models/update_notification_preferences.rb,
lib/openapi_client/models/admin_users_id_status_put_request.rb,
lib/openapi_client/models/system_stats_plan_breakdown_inner.rb,
lib/openapi_client/models/admin_revenue_get200_response_inner.rb,
lib/openapi_client/models/latency_trend_response_buckets_inner.rb,
lib/openapi_client/models/portal_notifications_put200_response.rb,
lib/openapi_client/models/delivery_trend_response_buckets_inner.rb,
lib/openapi_client/models/notifications_unread_count_get200_response.rb,
lib/openapi_client/models/endpoints_id_rotate_secret_post200_response.rb,
lib/openapi_client/models/endpoints_endpoint_id_transforms_test_post_request.rb

Overview

#HookSniff API

#Webhook delivery, monitoring, and management API. All endpoints under ‘/v1` require authentication via `Authorization: Bearer <api_key>` header unless marked as Public.

The version of the OpenAPI document: 1.0.0 Contact: support@hooksniff.vercel.app Generated by: openapi-generator.tech Generator version: 7.22.0

Defined Under Namespace

Modules: AuthLoginPost200Response Classes: APIKeysApi, AdminApi, AdminRevenueGet200ResponseInner, AdminSdkUpdatePostRequest, AdminUsersIdPlanPutRequest, AdminUsersIdStatusPutRequest, AlertRule, AlertsApi, AnalyticsApi, ApiClient, ApiError, ApiKeyInfo, ApiModelBase, ApplyTemplateRequest, ApplyTemplateResponse, AuditLogApi, Auth2faEnablePost200Response, AuthApi, AuthResponse, BatchReplayRequest, BatchResponse, BatchResponseErrorsInner, BatchWebhookRequest, BillingApi, BillingPortalPost200Response, ChangePasswordRequest, ChangeRoleRequest, Configuration, Confirm2faRequest, ContactApi, ContactRequest, ContactResponse, CreateAlertRequest, CreateApiKeyResponse, CreateEndpointRequest, CreateTeamRequest, CreateTransformRuleRequest, CreateWebhookRequest, CustomDomainsApi, CustomDomainsPostRequest, CustomerPortalApi, CustomerResponse, Delivery, DeliveryAttempt, DeliveryDetailsApi, DeliveryListResponse, DeliveryTrendResponse, DeliveryTrendResponseBucketsInner, DeviceTokenResponse, DevicesApi, Disable2faRequest, EmbedApi, Enable2faRequest, Endpoint, EndpointHealth, EndpointsApi, EndpointsEndpointIdTransformsTestPostRequest, EndpointsIdRotateSecretPost200Response, Error, EventsApi, ForgotPasswordRequest, HealthApi, InboundApi, InviteRequest, InvoiceResponse, LatencyTrendResponse, LatencyTrendResponseBucketsInner, LoginRequest, Notification, NotificationListResponse, NotificationPreferences, NotificationsApi, NotificationsUnreadCountGet200Response, OAuthApi, OutboundIPsApi, OutboundIpsResponse, PaginatedUsers, PlaygroundApi, PlaygroundGet200Response, PortalNotificationsPut200Response, PortalProfile, RateLimitsApi, RefreshTokenRequest, RegisterDeviceRequest, RegisterRequest, RegisterSchemaRequest, ResendVerificationRequest, ResetPasswordRequest, RetryPolicy, RoutingApi, RoutingInfo, SSOApi, SchemasApi, SearchApi, SearchResult, SimulatorApi, SimulatorPostRequest, SsoConfigPostRequest, StatsApi, StatsResponse, StreamApi, StreamParams, SubscriptionResponse, SuccessRateResponse, SystemStats, SystemStatsPlanBreakdownInner, SystemStatus, SystemStatusComponentsInner, Team, TeamDetailResponse, TeamInvite, TeamMember, TeamsApi, TemplatesApi, TestWebhookRequest, TestWebhookResponse, TransformRule, TransformsApi, TwoFactorRequiredResponse, UpdateEndpointRequest, UpdateNotificationPreferences, UpdateProfileRequest, UpdateRoutingRequest, UpgradeRequest, UpgradeResponse, UsageResponse, UserSummary, ValidateEventRequest, Verify2faRequest, VerifyEmailRequest, WebhookTemplate, WebhooksApi

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

OpenapiClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



161
162
163
164
165
166
167
 
# File 'lib/openapi_client.rb', line 161

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end