Module: Norbelys

Defined in:: lib/norbelys/version.rb,
lib/norbelys.rb,
lib/norbelys/api_error.rb,
lib/norbelys/api_client.rb,
lib/norbelys/models/field.rb,
lib/norbelys/models/group.rb,
lib/norbelys/api/files_api.rb,
lib/norbelys/configuration.rb,
lib/norbelys/models/domain.rb,
lib/norbelys/models/person.rb,
lib/norbelys/models/sender.rb,
lib/norbelys/api/fields_api.rb,
lib/norbelys/api/groups_api.rb,
lib/norbelys/api/people_api.rb,
lib/norbelys/api/verify_api.rb,
lib/norbelys/models/message.rb,
lib/norbelys/models/program.rb,
lib/norbelys/models/segment.rb,
lib/norbelys/models/variant.rb,
lib/norbelys/api/domains_api.rb,
lib/norbelys/api/senders_api.rb,
lib/norbelys/models/features.rb,
lib/norbelys/api/messages_api.rb,
lib/norbelys/api/programs_api.rb,
lib/norbelys/api/segments_api.rb,
lib/norbelys/models/api_error.rb,
lib/norbelys/models/team_size.rb,
lib/norbelys/models/verify_mx.rb,
lib/norbelys/api/analytics_api.rb,
lib/norbelys/models/domain_age.rb,
lib/norbelys/models/enrollment.rb,
lib/norbelys/models/field_list.rb,
lib/norbelys/models/field_type.rb,
lib/norbelys/models/group_list.rb,
lib/norbelys/models/sync_model.rb,
lib/norbelys/models/usage_plan.rb,
lib/norbelys/models/variant_ai.rb,
lib/norbelys/models/domain_list.rb,
lib/norbelys/models/file_object.rb,
lib/norbelys/models/file_upload.rb,
lib/norbelys/models/integration.rb,
lib/norbelys/models/person_list.rb,
lib/norbelys/models/pulse_value.rb,
lib/norbelys/models/sender_list.rb,
lib/norbelys/models/suppression.rb,
lib/norbelys/models/usage_meter.rb,
lib/norbelys/models/message_list.rb,
lib/norbelys/models/organization.rb,
lib/norbelys/models/program_list.rb,
lib/norbelys/models/report_share.rb,
lib/norbelys/models/segment_list.rb,
lib/norbelys/models/sender_usage.rb,
lib/norbelys/api/integrations_api.rb,
lib/norbelys/api/organization_api.rb,
lib/norbelys/api/suppressions_api.rb,
lib/norbelys/models/audience_rule.rb,
lib/norbelys/models/detach_result.rb,
lib/norbelys/models/domain_detail.rb,
lib/norbelys/models/domain_health.rb,
lib/norbelys/models/person_detail.rb,
lib/norbelys/models/person_erased.rb,
lib/norbelys/models/program_stats.rb,
lib/norbelys/models/pulse_program.rb,
lib/norbelys/models/sender_detail.rb,
lib/norbelys/models/slack_channel.rb,
lib/norbelys/models/verify_result.rb,
lib/norbelys/models/verify_syntax.rb,
lib/norbelys/models/audience_match.rb,
lib/norbelys/models/domain_sending.rb,
lib/norbelys/models/message_source.rb,
lib/norbelys/models/program_detail.rb,
lib/norbelys/models/verify_signals.rb,
lib/norbelys/models/analytics_query.rb,
lib/norbelys/models/audience_filter.rb,
lib/norbelys/models/audience_source.rb,
lib/norbelys/models/domain_capacity.rb,
lib/norbelys/models/domain_tracking.rb,
lib/norbelys/models/enrollment_list.rb,
lib/norbelys/models/inbound_message.rb,
lib/norbelys/models/message_address.rb,
lib/norbelys/models/warmup_settings.rb,
lib/norbelys/models/warmup_template.rb,
lib/norbelys/models/api_error_detail.rb,
lib/norbelys/models/audience_summary.rb,
lib/norbelys/models/integration_list.rb,
lib/norbelys/models/outbound_message.rb,
lib/norbelys/models/person_group_ref.rb,
lib/norbelys/models/person_list_item.rb,
lib/norbelys/models/suppression_list.rb,
lib/norbelys/models/domain_monitoring.rb,
lib/norbelys/models/enrollment_counts.rb,
lib/norbelys/models/program_list_item.rb,
lib/norbelys/models/sender_bulk_error.rb,
lib/norbelys/models/smtp_sender_input.rb,
lib/norbelys/models/suppression_scope.rb,
lib/norbelys/models/collection_address.rb,
lib/norbelys/models/integration_config.rb,
lib/norbelys/models/integration_status.rb,
lib/norbelys/models/message_attachment.rb,
lib/norbelys/models/organization_pulse.rb,
lib/norbelys/models/organization_usage.rb,
lib/norbelys/models/person_import_item.rb,
lib/norbelys/models/person_segment_ref.rb,
lib/norbelys/models/program_pause_meta.rb,
lib/norbelys/models/program_sender_ref.rb,
lib/norbelys/models/program_step_input.rb,
lib/norbelys/models/pulse_sender_fleet.rb,
lib/norbelys/models/step_with_variants.rb,
lib/norbelys/models/verify_email_input.rb,
lib/norbelys/models/verify_reason_code.rb,
lib/norbelys/models/voice_sender_input.rb,
lib/norbelys/models/warmup_today_tally.rb,
lib/norbelys/models/audience_week_point.rb,
lib/norbelys/models/connection_settings.rb,
lib/norbelys/models/create_sender_input.rb,
lib/norbelys/models/field_create_params.rb,
lib/norbelys/models/field_update_params.rb,
lib/norbelys/models/group_create_params.rb,
lib/norbelys/models/group_update_params.rb,
lib/norbelys/models/integration_options.rb,
lib/norbelys/models/message_test_params.rb,
lib/norbelys/models/organization_alerts.rb,
lib/norbelys/models/person_import_stats.rb,
lib/norbelys/models/tracking_dns_record.rb,
lib/norbelys/models/update_sender_input.rb,
lib/norbelys/models/verify_reachability.rb,
lib/norbelys/models/analytics_query_name.rb,
lib/norbelys/models/domain_create_params.rb,
lib/norbelys/models/domain_update_params.rb,
lib/norbelys/models/integration_provider.rb,
lib/norbelys/models/message_reply_params.rb,
lib/norbelys/models/organization_profile.rb,
lib/norbelys/models/person_create_params.rb,
lib/norbelys/models/person_import_reason.rb,
lib/norbelys/models/person_update_params.rb,
lib/norbelys/models/pulse_deliverability.rb,
lib/norbelys/models/sender_remove_result.rb,
lib/norbelys/models/sender_warmup_status.rb,
lib/norbelys/models/audience_condition_op.rb,
lib/norbelys/models/campaign_report_share.rb,
lib/norbelys/models/domain_sending_policy.rb,
lib/norbelys/models/email_variant_content.rb,
lib/norbelys/models/enroll_program_params.rb,
lib/norbelys/models/enroll_program_result.rb,
lib/norbelys/models/enrollment_person_ref.rb,
lib/norbelys/models/launch_program_params.rb,
lib/norbelys/models/launch_program_result.rb,
lib/norbelys/models/message_create_params.rb,
lib/norbelys/models/message_enroll_params.rb,
lib/norbelys/models/message_update_params.rb,
lib/norbelys/models/program_create_params.rb,
lib/norbelys/models/program_update_params.rb,
lib/norbelys/models/program_variant_input.rb,
lib/norbelys/models/programs_senders_list.rb,
lib/norbelys/models/segment_create_params.rb,
lib/norbelys/models/segment_update_params.rb,
lib/norbelys/models/warmup_runtime_status.rb,
lib/norbelys/models/analytics_query_params.rb,
lib/norbelys/models/analytics_query_result.rb,
lib/norbelys/models/domain_tracking_params.rb,
lib/norbelys/models/enrollment_program_ref.rb,
lib/norbelys/models/imap_connection_update.rb,
lib/norbelys/models/programs_audience_list.rb,
lib/norbelys/models/smtp_connection_update.rb,
lib/norbelys/models/dmarc_record_to_publish.rb,
lib/norbelys/models/integration_sync_result.rb,
lib/norbelys/models/message_attachment_list.rb,
lib/norbelys/models/organization_onboarding.rb,
lib/norbelys/models/suppression_bulk_params.rb,
lib/norbelys/models/suppression_bulk_result.rb,
lib/norbelys/models/ai_email_variant_content.rb,
lib/norbelys/models/audience_activity_action.rb,
lib/norbelys/models/audience_activity_params.rb,
lib/norbelys/models/audience_condition_value.rb,
lib/norbelys/models/bulk_update_sender_patch.rb,
lib/norbelys/models/domain_monitoring_params.rb,
lib/norbelys/models/group_add_members_params.rb,
lib/norbelys/models/group_add_members_result.rb,
lib/norbelys/models/message_attachment_input.rb,
lib/norbelys/models/self_hosted_sender_input.rb,
lib/norbelys/models/smtp_connection_settings.rb,
lib/norbelys/models/add_program_sender_params.rb,
lib/norbelys/models/audience_status_breakdown.rb,
lib/norbelys/models/bulk_update_senders_input.rb,
lib/norbelys/models/integration_notify_config.rb,
lib/norbelys/models/integration_update_params.rb,
lib/norbelys/models/message_source_attachment.rb,
lib/norbelys/models/monthly_email_usage_meter.rb,
lib/norbelys/models/people_bulk_create_params.rb,
lib/norbelys/models/people_bulk_create_result.rb,
lib/norbelys/models/provider_api_sender_input.rb,
lib/norbelys/models/suppression_create_params.rb,
lib/norbelys/models/bulk_update_senders_result.rb,
lib/norbelys/models/integration_connect_params.rb,
lib/norbelys/models/integration_connect_result.rb,
lib/norbelys/models/organization_alerts_params.rb,
lib/norbelys/models/organization_bounce_policy.rb,
lib/norbelys/models/organization_update_params.rb,
lib/norbelys/models/audience_activity_condition.rb,
lib/norbelys/models/message_attachment_download.rb,
lib/norbelys/models/organization_profile_params.rb,
lib/norbelys/models/audience_attribute_condition.rb,
lib/norbelys/models/domain_sending_policy_params.rb,
lib/norbelys/models/domain_sending_update_params.rb,
lib/norbelys/models/static_email_variant_content.rb,
lib/norbelys/models/audience_activity_link_filter.rb,
lib/norbelys/models/domain_tracking_update_params.rb,
lib/norbelys/models/audience_activity_link_match_op.rb,
lib/norbelys/models/organization_bounce_policy_params.rb

Overview

#Norbelys API

#The Norbelys API is a single, predictable REST surface for cold email and outreach — people, senders, programs, and sending all live behind the five patterns below. Developer-first and AI-first: every name is either already invented (Schema.org) or obvious. ## Authentication Every request authenticates with an org-scoped API key. Create one in Settings → API keys and send it as a bearer token: http GET https://api.norbelys.com/v1/people Authorization: Bearer ak_live_… Interactive agents may instead use OAuth 2.1 (see /auth.md and the /.well-known/oauth-protected-resource metadata). ## Conventions - Base URL — https://api.norbelys.com/v1. - JSON in, JSON out. Timestamps are ISO-8601 in UTC. - Cursor pagination. List endpoints take limit + cursor and return { data, hasMore, nextCursor } (offset-paged tables add page + total). - Expansions. Detail GETs take an expand[] query param to inline related data (e.g. GET /people/{id}?expand[]=timeline) instead of extra calls. - Soft deletes. Anything that has been used is archived, never hard-deleted — DELETE archives the resource and returns it. ## Errors Failures return the same envelope on every 4xx/5xx, with the matching HTTP status: json { \"error\": { \"type\": \"invalid_request\", \"code\": \"invalid_param\", \"message\": \"…\", \"hint\": \"…\", \"doc_url\": \"…\" } } type is a broad, machine-routable category derived from the status; code is the stable machine contract you branch on (never the human message). See the ApiError schema. ## Idempotency Every POST accepts an optional Idempotency-Key header. Reuse the same key to replay the original result for 24h instead of re-executing — so a retried create can never double-charge or duplicate a record. ## Rate limits & versioning Abuse control is enforced at the edge; responses advertise the policy via the RateLimit-Policy header, and a 429 carries Retry-After. The API is versioned in the URL path (/v1). Breaking changes ship under a new version; a retiring surface is announced with Deprecation + Sunset response headers at least 90 days ahead.

The version of the OpenAPI document: 0.0.1

Generated by: https://openapi-generator.tech Generator version: 7.10.0

Defined Under Namespace

Modules: AudienceConditionValue, AudienceRule, CreateSenderInput, EmailVariantContent, Message, MessageCreateParams Classes: AddProgramSenderParams, AiEmailVariantContent, AnalyticsApi, AnalyticsQuery, AnalyticsQueryName, AnalyticsQueryParams, AnalyticsQueryResult, ApiClient, ApiError, ApiErrorDetail, AudienceActivityAction, AudienceActivityCondition, AudienceActivityLinkFilter, AudienceActivityLinkMatchOp, AudienceActivityParams, AudienceAttributeCondition, AudienceConditionOp, AudienceFilter, AudienceMatch, AudienceSource, AudienceStatusBreakdown, AudienceSummary, AudienceWeekPoint, BulkUpdateSenderPatch, BulkUpdateSendersInput, BulkUpdateSendersResult, CampaignReportShare, CollectionAddress, Configuration, ConnectionSettings, DetachResult, DmarcRecordToPublish, Domain, DomainAge, DomainCapacity, DomainCreateParams, DomainDetail, DomainHealth, DomainList, DomainMonitoring, DomainMonitoringParams, DomainSending, DomainSendingPolicy, DomainSendingPolicyParams, DomainSendingUpdateParams, DomainTracking, DomainTrackingParams, DomainTrackingUpdateParams, DomainUpdateParams, DomainsApi, EnrollProgramParams, EnrollProgramResult, Enrollment, EnrollmentCounts, EnrollmentList, EnrollmentPersonRef, EnrollmentProgramRef, Features, Field, FieldCreateParams, FieldList, FieldType, FieldUpdateParams, FieldsApi, FileObject, FileUpload, FilesApi, Group, GroupAddMembersParams, GroupAddMembersResult, GroupCreateParams, GroupList, GroupUpdateParams, GroupsApi, ImapConnectionUpdate, InboundMessage, Integration, IntegrationConfig, IntegrationConnectParams, IntegrationConnectResult, IntegrationList, IntegrationNotifyConfig, IntegrationOptions, IntegrationProvider, IntegrationStatus, IntegrationSyncResult, IntegrationUpdateParams, IntegrationsApi, LaunchProgramParams, LaunchProgramResult, MessageAddress, MessageAttachment, MessageAttachmentDownload, MessageAttachmentInput, MessageAttachmentList, MessageEnrollParams, MessageList, MessageReplyParams, MessageSource, MessageSourceAttachment, MessageTestParams, MessageUpdateParams, MessagesApi, MonthlyEmailUsageMeter, Organization, OrganizationAlerts, OrganizationAlertsParams, OrganizationApi, OrganizationBouncePolicy, OrganizationBouncePolicyParams, OrganizationOnboarding, OrganizationProfile, OrganizationProfileParams, OrganizationPulse, OrganizationUpdateParams, OrganizationUsage, OutboundMessage, PeopleApi, PeopleBulkCreateParams, PeopleBulkCreateResult, Person, PersonCreateParams, PersonDetail, PersonErased, PersonGroupRef, PersonImportItem, PersonImportReason, PersonImportStats, PersonList, PersonListItem, PersonSegmentRef, PersonUpdateParams, Program, ProgramCreateParams, ProgramDetail, ProgramList, ProgramListItem, ProgramPauseMeta, ProgramSenderRef, ProgramStats, ProgramStepInput, ProgramUpdateParams, ProgramVariantInput, ProgramsApi, ProgramsAudienceList, ProgramsSendersList, ProviderApiSenderInput, PulseDeliverability, PulseProgram, PulseSenderFleet, PulseValue, ReportShare, Segment, SegmentCreateParams, SegmentList, SegmentUpdateParams, SegmentsApi, SelfHostedSenderInput, Sender, SenderBulkError, SenderDetail, SenderList, SenderRemoveResult, SenderUsage, SenderWarmupStatus, SendersApi, SlackChannel, SmtpConnectionSettings, SmtpConnectionUpdate, SmtpSenderInput, StaticEmailVariantContent, StepWithVariants, Suppression, SuppressionBulkParams, SuppressionBulkResult, SuppressionCreateParams, SuppressionList, SuppressionScope, SuppressionsApi, SyncModel, TeamSize, TrackingDnsRecord, UpdateSenderInput, UsageMeter, UsagePlan, Variant, VariantAi, VerifyApi, VerifyEmailInput, VerifyMx, VerifyReachability, VerifyReasonCode, VerifyResult, VerifySignals, VerifySyntax, VoiceSenderInput, WarmupRuntimeStatus, WarmupSettings, WarmupTemplate, WarmupTodayTally

Constant Summary collapse

VERSION =

'0.1.0'

Class Method Summary collapse

.configure ⇒ Object
Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block. Norbelys.configure do |config| config.username = "xxx" config.password = "xxx" end If no block given, return the default Configuration object.

# File 'lib/norbelys.rb', line 235

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