Module: Parlo

Defined in:
lib/parlo-sdk/version.rb,
lib/parlo-sdk.rb,
lib/parlo-sdk/api_error.rb,
lib/parlo-sdk/api_client.rb,
lib/parlo-sdk/models/email.rb,
lib/parlo-sdk/models/error.rb,
lib/parlo-sdk/configuration.rb,
lib/parlo-sdk/models/domain.rb,
lib/parlo-sdk/api/emails_api.rb,
lib/parlo-sdk/api_model_base.rb,
lib/parlo-sdk/api/domains_api.rb,
lib/parlo-sdk/models/dns_record.rb,
lib/parlo-sdk/models/auth_health.rb,
lib/parlo-sdk/models/email_created.rb,
lib/parlo-sdk/models/domain_summary.rb,
lib/parlo-sdk/models/auth_health_spf.rb,
lib/parlo-sdk/models/auth_health_dkim.rb,
lib/parlo-sdk/models/auth_health_dmarc.rb,
lib/parlo-sdk/models/send_email_request.rb,
lib/parlo-sdk/models/create_domain_request.rb,
lib/parlo-sdk/models/send_email_request_cc.rb,
lib/parlo-sdk/models/send_email_request_to.rb,
lib/parlo-sdk/models/list_domains200_response.rb,
lib/parlo-sdk/models/delete_domain200_response.rb

Overview

#Parlo API

#The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch. All requests authenticate with a company API key as an HTTP bearer token: Authorization: Bearer parlo_live_xxx. Errors return a JSON body of the shape { \"message\": string, \"code\": string }.

The version of the OpenAPI document: 1.0.0

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

Defined Under Namespace

Modules: SendEmailRequestCc, SendEmailRequestTo Classes: ApiClient, ApiError, ApiModelBase, AuthHealth, AuthHealthDkim, AuthHealthDmarc, AuthHealthSpf, Configuration, CreateDomainRequest, DeleteDomain200Response, DnsRecord, Domain, DomainSummary, DomainsApi, Email, EmailCreated, EmailsApi, Error, ListDomains200Response, SendEmailRequest

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

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



50
51
52
53
54
55
56
 
# File 'lib/parlo-sdk.rb', line 50

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