Module: Sendmux::Sending::Generated

Defined in:
lib/sendmux_sending_generated/version.rb,
lib/sendmux_sending_generated.rb,
lib/sendmux_sending_generated/api_error.rb,
lib/sendmux_sending_generated/api_client.rb,
lib/sendmux_sending_generated/models/meta.rb,
lib/sendmux_sending_generated/configuration.rb,
lib/sendmux_sending_generated/api/emails_api.rb,
lib/sendmux_sending_generated/api_model_base.rb,
lib/sendmux_sending_generated/models/address.rb,
lib/sendmux_sending_generated/models/recipient.rb,
lib/sendmux_sending_generated/models/attachment.rb,
lib/sendmux_sending_generated/models/error_issue.rb,
lib/sendmux_sending_generated/models/error_detail.rb,
lib/sendmux_sending_generated/models/batch_summary.rb,
lib/sendmux_sending_generated/models/error_response.rb,
lib/sendmux_sending_generated/models/success_envelope.rb,
lib/sendmux_sending_generated/models/batch_result_item.rb,
lib/sendmux_sending_generated/models/send_success_data.rb,
lib/sendmux_sending_generated/models/batch_send_request.rb,
lib/sendmux_sending_generated/models/email_send_request.rb,
lib/sendmux_sending_generated/models/send_success_response.rb,
lib/sendmux_sending_generated/models/batch_send_success_data.rb,
lib/sendmux_sending_generated/models/batch_send_success_response.rb

Overview

#SendMux Sending API

#Send emails programmatically via the SendMux email infrastructure. Every response carries an ‘X-Request-Id` header; errors include a `retryable` flag. 429 and 503 responses include `Retry-After`. Mutating endpoints accept an `Idempotency-Key` header for safe retries.

The version of the OpenAPI document: 1.0.0

Generated by: openapi-generator.tech Generator version: 7.22.0

Defined Under Namespace

Classes: Address, ApiClient, ApiError, ApiModelBase, Attachment, BatchResultItem, BatchSendRequest, BatchSendSuccessData, BatchSendSuccessResponse, BatchSummary, Configuration, EmailSendRequest, EmailsApi, ErrorDetail, ErrorIssue, ErrorResponse, Meta, Recipient, SendSuccessData, SendSuccessResponse, SuccessEnvelope

Constant Summary collapse

VERSION =
'1.0.0'

Class Method Summary collapse

Class Method Details

.configureObject

Customize default settings for the SDK using block.

Sendmux::Sending::Generated.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



49
50
51
52
53
54
55
# File 'lib/sendmux_sending_generated.rb', line 49

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