sendpost_rb_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ef4b6cc42c787f7772d97f0154a3a3cabcf5fe2c5211da85d26b860100eb8f4
+  data.tar.gz: 2bf823966f2583546c97eb80b2d586d99b7383ea8cfedb4753aae37fa138bb4a
+SHA512:
+  metadata.gz: 27d40e5f31222c9ce53a141d0e0f4b7c66fc9a1a8210bb4b485bd734b3238d353510bf8ef29e69a48bbd9a3f21aae855c9b222bd4b8bc2a5d0c2c1e8304bd502
+  data.tar.gz: afb176f0f600c8a668546c92d489c9415b077d6cc45558bb455b2eab824763983f3a5ffe14ec557a304d2c8e1c8a72c86984b7ae73951d6a00df9b791c8a7dba

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,79 @@
+# sendpost_rb_sdk
+
+Sendpost - the Ruby gem for the SendPost API
+
+Email API and SMTP relay to not just send and measure email sending, but also alert and optimise. We provide you with tools, expertise and support needed to reliably deliver emails to your customers inboxes on time, every time.
+
+
+## Installation
+
+```shell
+gem install sendpost_rb_sdk-1.0.0.gem
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+require 'sendpost_rb_sdk'
+
+api_instance = Sendpost::EmailApi.new
+x_sub_account_api_key = 'your_api_key' # String | Sub-Account API Key
+email_message = Sendpost::EmailMessage.new
+email_message.from = {
+  email: 'richard@piedpiper.com'
+}
+email_message.to = [{
+  email: 'gavin@hooli.com'
+}]
+email_message.subject = 'Hello World'
+email_message.html_body =  '<strong>it works!</strong>'
+email_message.ippool = 'PiedPiper'
+
+opts = {
+  email_message: email_message # EmailMessage | Email message
+}
+
+begin
+  result = api_instance.send_email(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Exception when calling EmailApi->send_email: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.sendpost.io/api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*Sendpost::EmailApi* | [**send_email**](docs/EmailApi.md#send_email) | **POST** /subaccount/email/ | 
+*Sendpost::EmailApi* | [**send_email_with_template**](docs/EmailApi.md#send_email_with_template) | **POST** /subaccount/email/template | 
+
+
+## Documentation for Models
+
+ - [Sendpost::Attachment](docs/Attachment.md)
+ - [Sendpost::City](docs/City.md)
+ - [Sendpost::CopyTo](docs/CopyTo.md)
+ - [Sendpost::Device](docs/Device.md)
+ - [Sendpost::EmailMessage](docs/EmailMessage.md)
+ - [Sendpost::EmailResponse](docs/EmailResponse.md)
+ - [Sendpost::EventMetadata](docs/EventMetadata.md)
+ - [Sendpost::From](docs/From.md)
+ - [Sendpost::Os](docs/Os.md)
+ - [Sendpost::QEmailMessage](docs/QEmailMessage.md)
+ - [Sendpost::QEvent](docs/QEvent.md)
+ - [Sendpost::ReplyTo](docs/ReplyTo.md)
+ - [Sendpost::To](docs/To.md)
+ - [Sendpost::UserAgent](docs/UserAgent.md)
+ - [Sendpost::WebhookEvent](docs/WebhookEvent.md)
+
+
+## Documentation for Authorization
+
+Endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Attachment.md

@@ -0,0 +1,20 @@
+# Sendpost::Attachment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** |  | [optional] |
+| **filename** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::Attachment.new(
+  content: V2VsY29tZSB0byBTZW5kUG9zdCEgOikK,
+  filename: file0.txt
+)
+```
+

data/docs/City.md

@@ -0,0 +1,26 @@
+# Sendpost::City
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **city_id** | **Integer** |  | [optional] |
+| **continent_code** | **String** |  | [optional] |
+| **country_code** | **String** |  | [optional] |
+| **postal_code** | **String** |  | [optional] |
+| **time_zone** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::City.new(
+  city_id: null,
+  continent_code: null,
+  country_code: null,
+  postal_code: null,
+  time_zone: null
+)
+```
+

data/docs/CopyTo.md

@@ -0,0 +1,22 @@
+# Sendpost::CopyTo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **custom_fields** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::CopyTo.new(
+  name: Nelson Bighetti,
+  email: bighead@bachmanity.com,
+  custom_fields: {"Company":"Bachmanity"}
+)
+```
+

data/docs/Device.md

@@ -0,0 +1,18 @@
+# Sendpost::Device
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **family** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::Device.new(
+  family: null
+)
+```
+

data/docs/EmailApi.md

@@ -0,0 +1,145 @@
+# Sendpost::EmailApi
+
+All URIs are relative to *https://api.sendpost.io/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**send_email**](EmailApi.md#send_email) | **POST** /subaccount/email/ |  |
+| [**send_email_with_template**](EmailApi.md#send_email_with_template) | **POST** /subaccount/email/template |  |
+
+
+## send_email
+
+> <Array<EmailResponse>> send_email(x_sub_account_api_key, opts)
+
+
+
+Send Email To Contacts
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_rb_sdk'
+
+api_instance = Sendpost::EmailApi.new
+x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
+opts = {
+  email_message: Sendpost::EmailMessage.new # EmailMessage | Email message
+}
+
+begin
+  
+  result = api_instance.send_email(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling EmailApi->send_email: #{e}"
+end
+```
+
+#### Using the send_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<EmailResponse>>, Integer, Hash)> send_email_with_http_info(x_sub_account_api_key, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.send_email_with_http_info(x_sub_account_api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<EmailResponse>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling EmailApi->send_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
+| **email_message** | [**EmailMessage**](EmailMessage.md) | Email message | [optional] |
+
+### Return type
+
+[**Array&lt;EmailResponse&gt;**](EmailResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_email_with_template
+
+> <Array<EmailResponse>> send_email_with_template(x_sub_account_api_key, opts)
+
+
+
+Send Email To Contacts With Template
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_rb_sdk'
+
+api_instance = Sendpost::EmailApi.new
+x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
+opts = {
+  email_message: Sendpost::EmailMessage.new # EmailMessage | Email message
+}
+
+begin
+  
+  result = api_instance.send_email_with_template(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling EmailApi->send_email_with_template: #{e}"
+end
+```
+
+#### Using the send_email_with_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<EmailResponse>>, Integer, Hash)> send_email_with_template_with_http_info(x_sub_account_api_key, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.send_email_with_template_with_http_info(x_sub_account_api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<EmailResponse>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling EmailApi->send_email_with_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
+| **email_message** | [**EmailMessage**](EmailMessage.md) | Email message | [optional] |
+
+### Return type
+
+[**Array&lt;EmailResponse&gt;**](EmailResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EmailMessage.md

@@ -0,0 +1,46 @@
+# Sendpost::EmailMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **attachments** | [**Array<Attachment>**](Attachment.md) |  | [optional] |
+| **from** | [**From**](From.md) |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **html_body** | **String** |  | [optional] |
+| **ippool** | **String** |  | [optional] |
+| **pre_text** | **String** |  | [optional] |
+| **reply_to** | [**ReplyTo**](ReplyTo.md) |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **template** | **String** |  | [optional] |
+| **text_body** | **String** |  | [optional] |
+| **to** | [**Array<To>**](To.md) |  | [optional] |
+| **track_clicks** | **Boolean** |  | [optional] |
+| **track_opens** | **Boolean** |  | [optional] |
+| **headers** | **Object** |  | [optional] |
+| **amp_body** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::EmailMessage.new(
+  attachments: null,
+  from: null,
+  groups: ["promotion","techcrunch-launch"],
+  html_body: <html><body>Thanks for your trust in Hooli {{.Name}}. We are trying launching Nucleus at TechCrunch Disrupt - our cloud based compression platform. That you could easily integrate it into {{.Company}}.</html></body>,
+  ippool: promotional-hooli,
+  pre_text: Follow the steps to integrate our video compression API,
+  reply_to: null,
+  subject: Welcome to Nucles {{.Name}}:) Let's get started,
+  template: welcome-onboarding,
+  text_body: Thanks for your trust in Hooli {{.Name}}. We are trying launching Nucleus at TechCrunch Disrupt - our cloud based compression platform. That you could easily integrate it into {{.Company}},
+  to: null,
+  track_clicks: true,
+  track_opens: true,
+  headers: {"X-Campaign-Id":"techcrunch-launch"},
+  amp_body: null
+)
+```
+

data/docs/EmailResponse.md

@@ -0,0 +1,26 @@
+# Sendpost::EmailResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error_code** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+| **message_id** | **String** |  | [optional] |
+| **submitted_at** | **Integer** |  | [optional] |
+| **to** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::EmailResponse.new(
+  error_code: 500,
+  message: ok,
+  message_id: 0e139af1-f1xe-480d-b08d-eg28m48kf48d,
+  submitted_at: 1567512491587205124,
+  to: bighead@bachmanity.com
+)
+```
+

data/docs/EventMetadata.md

@@ -0,0 +1,30 @@
+# Sendpost::EventMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clicked_url** | **String** |  | [optional] |
+| **device** | [**Device**](Device.md) |  | [optional] |
+| **geo** | [**City**](City.md) |  | [optional] |
+| **os** | [**Os**](Os.md) |  | [optional] |
+| **smtp_code** | **Integer** |  | [optional] |
+| **smtp_description** | **String** |  | [optional] |
+| **user_agent** | [**UserAgent**](UserAgent.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::EventMetadata.new(
+  clicked_url: null,
+  device: null,
+  geo: null,
+  os: null,
+  smtp_code: 200,
+  smtp_description: email delivered successfully,
+  user_agent: null
+)
+```
+

data/docs/From.md

@@ -0,0 +1,20 @@
+# Sendpost::From
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::From.new(
+  email: gavin@hooli.com,
+  name: Gavin Belson
+)
+```
+

data/docs/Os.md

@@ -0,0 +1,26 @@
+# Sendpost::Os
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **family** | **String** |  | [optional] |
+| **major** | **String** |  | [optional] |
+| **minor** | **String** |  | [optional] |
+| **patch** | **String** |  | [optional] |
+| **patch_minor** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::Os.new(
+  family: null,
+  major: null,
+  minor: null,
+  patch: null,
+  patch_minor: null
+)
+```
+

data/docs/QEmailMessage.md

@@ -0,0 +1,70 @@
+# Sendpost::QEmailMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **Integer** |  | [optional] |
+| **amp_body** | **String** |  | [optional] |
+| **attachments** | [**Array<Attachment>**](Attachment.md) |  | [optional] |
+| **attempt** | **Integer** |  | [optional] |
+| **custom_fields** | **Object** |  | [optional] |
+| **email_type** | **String** |  | [optional] |
+| **from** | [**From**](From.md) |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **header_bcc** | [**Array<CopyTo>**](CopyTo.md) |  | [optional] |
+| **header_cc** | [**Array<CopyTo>**](CopyTo.md) |  | [optional] |
+| **header_to** | [**To**](To.md) |  | [optional] |
+| **headers** | **Object** |  | [optional] |
+| **html_body** | **String** |  | [optional] |
+| **ip_id** | **Integer** |  | [optional] |
+| **ip_pool** | **String** |  | [optional] |
+| **local_ip** | **String** |  | [optional] |
+| **message_id** | **String** |  | [optional] |
+| **pre_text** | **String** |  | [optional] |
+| **public_ip** | **String** |  | [optional] |
+| **reply_to** | [**ReplyTo**](ReplyTo.md) |  | [optional] |
+| **sub_account_id** | **Integer** |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **submitted_at** | **Integer** |  | [optional] |
+| **text_body** | **String** |  | [optional] |
+| **to** | [**To**](To.md) |  | [optional] |
+| **track_clicks** | **Boolean** |  | [optional] |
+| **track_opens** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::QEmailMessage.new(
+  account_id: 117,
+  amp_body: null,
+  attachments: null,
+  attempt: 1,
+  custom_fields: {"Company":"Bachmanity"},
+  email_type: gmail,
+  from: null,
+  groups: ["promotion","techcrunch-launch"],
+  header_bcc: null,
+  header_cc: null,
+  header_to: null,
+  headers: {"X-Campaign-Id":"techcrunch-launch"},
+  html_body: <html><body>{{.FirstName}}, I have been following your journey since {{.Company}} days. Just wanted to thank you for inspiring us.</body></html>,
+  ip_id: 18,
+  ip_pool: transactional-piedpiper,
+  local_ip: 172.30.2.45,
+  message_id: 0c6c7600-e68d-498e-b924-d8105130cc1d,
+  pre_text: thanks for the inspiration ...,
+  public_ip: 52.13.11.9,
+  reply_to: null,
+  sub_account_id: 234,
+  subject: Building great products?,
+  submitted_at: 1567512491587205024,
+  text_body: {{.FirstName}}, I have been following your journey since {{.Company}} days. Just wanted to thank you for inspiring us.,
+  to: null,
+  track_clicks: true,
+  track_opens: true
+)
+```
+

data/docs/QEvent.md

@@ -0,0 +1,42 @@
+# Sendpost::QEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **Integer** |  | [optional] |
+| **event_id** | **String** |  | [optional] |
+| **event_metadata** | [**EventMetadata**](EventMetadata.md) |  | [optional] |
+| **from** | **String** |  | [optional] |
+| **groups** | **Array<String>** |  | [optional] |
+| **ip_id** | **Integer** |  | [optional] |
+| **message_id** | **String** |  | [optional] |
+| **message_type** | **String** |  | [optional] |
+| **sub_account_id** | **Integer** |  | [optional] |
+| **submitted_at** | **Integer** |  | [optional] |
+| **to** | **String** |  | [optional] |
+| **tpsp_id** | **Integer** |  | [optional] |
+| **type** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::QEvent.new(
+  account_id: 8,
+  event_id: 8690608c-2538-4173-a463-f0de475633da,
+  event_metadata: null,
+  from: gavin@hooli.com,
+  groups: ["promotion","techcrunch-launch"],
+  ip_id: 7,
+  message_id: edcb833d-5ef6-48c3-936f-1de0b74843d4,
+  message_type: default,
+  sub_account_id: 28,
+  submitted_at: 1689245147247766056,
+  to: richard@piedpiper.com,
+  tpsp_id: 0,
+  type: 2
+)
+```
+

data/docs/ReplyTo.md

@@ -0,0 +1,20 @@
+# Sendpost::ReplyTo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::ReplyTo.new(
+  email: welcome@hooli.vom,
+  name: Team @ Hooli
+)
+```
+

data/docs/To.md

@@ -0,0 +1,26 @@
+# Sendpost::To
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **cc** | [**Array<CopyTo>**](CopyTo.md) |  | [optional] |
+| **bcc** | [**Array<CopyTo>**](CopyTo.md) |  | [optional] |
+| **custom_fields** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::To.new(
+  name: Elrich Bachman,
+  email: elrich@bachmanity.com,
+  cc: null,
+  bcc: null,
+  custom_fields: {"Company":"Bachmanity"}
+)
+```
+

data/docs/UserAgent.md

@@ -0,0 +1,24 @@
+# Sendpost::UserAgent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **family** | **String** |  | [optional] |
+| **major** | **String** |  | [optional] |
+| **minor** | **String** |  | [optional] |
+| **patch** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_rb_sdk'
+
+instance = Sendpost::UserAgent.new(
+  family: null,
+  major: null,
+  minor: null,
+  patch: null
+)
+```
+