sendpost_ruby_sdk 1.0.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9eb2149c22351f9d17d9847b0033f1bcc4e92af1425143e350f9de9ed0cd2c03
-  data.tar.gz: 359e1e022b62989d09c73ac780da73aec846ace95cc8029d0b24836d0783053a
+  metadata.gz: e454f81043b5693663756f6fc7e51ef326e55ac28a117c965b62d09db98dd432
+  data.tar.gz: bb22b794b02c71a78d315bcee4d6dfceca53abff1b821eb6f07736087faed250
 SHA512:
-  metadata.gz: e1e71a7501180a3796d5ad29a933adfb0d8278b896e92ce65688022f6ecc1eb1636767af0475833d3b9dfad0ddc2e39b253d40f1e9edde32cc6b58ddc03e3f40
-  data.tar.gz: 3f1481486c0ecff2636699e4f2c02f2e90f0a2776a110fdf4a3ac32275246a72f0c0f23b3cde6a7cbea1bf28b0c851c167b0b1800685e05f3eadff84ae997cb2
+  metadata.gz: 72adb05a860d07149b9d17c7be4dd8ff754d0efae495e9a9d35554df89dce54d01f77b02afbda460cec20666e182e82efcf0e9350945e2dabefae41380cbd5d9
+  data.tar.gz: 572e819e7769b08316ecde125c1054eb7313a14e596098d94c9cc5204c495d91a1f72b7271d27af417909d5ee065b92a896c77a6ccc300bcc44b5acc26a8b90e

data/README.md

@@ -8,7 +8,7 @@ Email API and SMTP relay to not just send and measure email sending, but also al
 ## Installation
 
 ```shell
-gem install sendpost_ruby_sdk-1.0.0.gem
+gem install sendpost_ruby_sdk
 ```
 
 ## Getting Started
@@ -44,6 +44,150 @@ end
 
 ```
 
+Example with cc, bcc and template:
+
+```ruby
+require 'sendpost_ruby_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',
+  cc: [{ email: 'dinesh@bachmanity.com' }],
+  bcc: [{ email: 'jian@bachmanity.com' }]
+}]
+
+email_message.subject = 'Hello World'
+email_message.template = 'Welcome Mail'
+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_with_template(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Exception when calling EmailApi->send_email: #{e}"
+end
+
+```
+
+## Suppressions
+
+Create Suppressions
+
+```ruby
+require 'sendpost_ruby_sdk'
+api_instance = Sendpost::SuppressionApi.new
+
+x_sub_account_api_key = 'your_api_key'
+
+r_suppression = Sendpost::RSuppression.new
+
+r_suppression.hard_bounce = [{ email: 'richard@piedpiper_fake.com' }]
+
+# fields are optional, but you have to send at least one of them.
+
+# r_suppression.manual = [{ email: 'richard@piedpiper_fake2.com' }]
+# r_suppression.spam_complaint = [{ email: 'richard@piedpiper_fake3.com' }]
+# r_suppression.unsubscribe = [{ email: 'richard@piedpiper_fake4.com' }]
+
+opts = {
+  r_suppression: r_suppression
+}
+
+p opts
+
+begin
+  result = api_instance.create_suppressions(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Exception when calling SuppressionApi->create_suppressions: #{e}"
+end
+```
+
+Get Suppressions
+
+```ruby
+require 'sendpost_ruby_sdk'
+api_instance = Sendpost::SuppressionApi.new
+
+x_sub_account_api_key = 'your_api_key'
+
+opts = {
+  offset: 0,
+  limit: 20,
+  search: nil,
+  from: '2023-06-07',
+  to: '2023-08-04'
+}
+
+p opts
+
+begin
+  result = api_instance.get_suppressions(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Exception when calling SuppressionApi->get_suppressions: #{e}"
+end
+```
+
+Delete Suppression
+
+```ruby
+require 'sendpost_ruby_sdk'
+api_instance = Sendpost::SuppressionApi.new
+
+x_sub_account_api_key = 'your_api_key'
+
+rd_suppression = Sendpost::RDSuppression.new
+
+rd_suppression.suppressions = [{ email: 'richard@piedpiper_fake4.com' }]
+
+opts = {
+  rd_suppression: rd_suppression
+}
+
+p opts
+
+begin
+  result = api_instance.delete_suppression(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Exception when calling SuppressionApi->delete_suppression: #{e}"
+end
+```
+
+Count Suppression
+
+```ruby
+require 'sendpost_ruby_sdk'
+api_instance = Sendpost::SuppressionApi.new
+
+x_sub_account_api_key = 'your_api_key'
+
+opts = {
+  from: '2023-06-07',
+  to: '2023-08-04'
+}
+
+p opts
+
+begin
+  result = api_instance.count(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Exception when calling SuppressionApi->count: #{e}"
+end
+```
+
 ## Documentation for API Endpoints
 
 All URIs are relative to *https://api.sendpost.io/api/v1*
@@ -52,6 +196,10 @@ 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 | 
+*Sendpost::SuppressionApi* | [**count**](docs/SuppressionApi.md#count) | **GET** /subaccount/suppression/count | 
+*Sendpost::SuppressionApi* | [**create_suppressions**](docs/SuppressionApi.md#create_suppressions) | **POST** /subaccount/suppression/ | 
+*Sendpost::SuppressionApi* | [**delete_suppression**](docs/SuppressionApi.md#delete_suppression) | **DELETE** /subaccount/suppression/ | 
+*Sendpost::SuppressionApi* | [**get_suppressions**](docs/SuppressionApi.md#get_suppressions) | **GET** /subaccount/suppression/ | 
 
 
 ## Documentation for Models
@@ -59,6 +207,8 @@ Class | Method | HTTP request | Description
  - [Sendpost::Attachment](docs/Attachment.md)
  - [Sendpost::City](docs/City.md)
  - [Sendpost::CopyTo](docs/CopyTo.md)
+ - [Sendpost::CountStat](docs/CountStat.md)
+ - [Sendpost::DeleteResponse](docs/DeleteResponse.md)
  - [Sendpost::Device](docs/Device.md)
  - [Sendpost::EmailMessage](docs/EmailMessage.md)
  - [Sendpost::EmailResponse](docs/EmailResponse.md)
@@ -67,7 +217,11 @@ Class | Method | HTTP request | Description
  - [Sendpost::Os](docs/Os.md)
  - [Sendpost::QEmailMessage](docs/QEmailMessage.md)
  - [Sendpost::QEvent](docs/QEvent.md)
+ - [Sendpost::RDSuppression](docs/RDSuppression.md)
+ - [Sendpost::RSuppression](docs/RSuppression.md)
  - [Sendpost::ReplyTo](docs/ReplyTo.md)
+ - [Sendpost::Suppression](docs/Suppression.md)
+ - [Sendpost::SuppressionEmail](docs/SuppressionEmail.md)
  - [Sendpost::To](docs/To.md)
  - [Sendpost::UserAgent](docs/UserAgent.md)
  - [Sendpost::WebhookEvent](docs/WebhookEvent.md)

data/config-ruby.json

@@ -4,8 +4,8 @@
   "gemAuthor": "Sendpost",
   "gemAuthorEmail": "dev@sendpost.io",
   "gemDescription": "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.",
-  "gemHomepage": "https://sendpost.io/",
+  "gemHomepage": "https://github.com/sendpost/sendpost_ruby_sdk",
   "gemSummary": "SendPost Ruby API",
   "gemName": "sendpost_ruby_sdk",
-  "gemVersion": "1.0.0"
+  "gemVersion": "1.2.2"
 }

data/docs/CountStat.md

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

data/docs/DeleteResponse.md

@@ -0,0 +1,20 @@
+# Sendpost::DeleteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::DeleteResponse.new(
+  id: null,
+  message: null
+)
+```
+

data/docs/EventMetadata.md

@@ -5,6 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **clicked_url** | **String** |  | [optional] |
+| **tracked_ip** | **String** |  | [optional] |
+| **raw_user_agent** | **String** |  | [optional] |
 | **device** | [**Device**](Device.md) |  | [optional] |
 | **geo** | [**City**](City.md) |  | [optional] |
 | **os** | [**Os**](Os.md) |  | [optional] |
@@ -19,6 +21,8 @@ require 'sendpost_ruby_sdk'
 
 instance = Sendpost::EventMetadata.new(
   clicked_url: null,
+  tracked_ip: null,
+  raw_user_agent: null,
   device: null,
   geo: null,
   os: null,

data/docs/RDSuppression.md

@@ -0,0 +1,18 @@
+# Sendpost::RDSuppression
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **suppressions** | [**Array<SuppressionEmail>**](SuppressionEmail.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::RDSuppression.new(
+  suppressions: null
+)
+```
+

data/docs/RSuppression.md

@@ -0,0 +1,24 @@
+# Sendpost::RSuppression
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hard_bounce** | [**Array<SuppressionEmail>**](SuppressionEmail.md) |  | [optional] |
+| **manual** | [**Array<SuppressionEmail>**](SuppressionEmail.md) |  | [optional] |
+| **spam_complaint** | [**Array<SuppressionEmail>**](SuppressionEmail.md) |  | [optional] |
+| **unsubscribe** | [**Array<SuppressionEmail>**](SuppressionEmail.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::RSuppression.new(
+  hard_bounce: null,
+  manual: null,
+  spam_complaint: null,
+  unsubscribe: null
+)
+```
+

data/docs/Suppression.md

@@ -0,0 +1,26 @@
+# Sendpost::Suppression
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **Integer** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **id** | **Integer** |  | [optional] |
+| **reason** | **Integer** |  | [optional] |
+| **smtp_error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::Suppression.new(
+  created: null,
+  email: null,
+  id: null,
+  reason: null,
+  smtp_error: null
+)
+```
+

data/docs/SuppressionApi.md

@@ -0,0 +1,293 @@
+# Sendpost::SuppressionApi
+
+All URIs are relative to *https://api.sendpost.io/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**count**](SuppressionApi.md#count) | **GET** /subaccount/suppression/count |  |
+| [**create_suppressions**](SuppressionApi.md#create_suppressions) | **POST** /subaccount/suppression/ |  |
+| [**delete_suppression**](SuppressionApi.md#delete_suppression) | **DELETE** /subaccount/suppression/ |  |
+| [**get_suppressions**](SuppressionApi.md#get_suppressions) | **GET** /subaccount/suppression/ |  |
+
+
+## count
+
+> <CountStat> count(x_sub_account_api_key, opts)
+
+
+
+Count Total Suppressions
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+
+api_instance = Sendpost::SuppressionApi.new
+x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
+opts = {
+  from: 'from_example', # String | from date
+  to: 'to_example' # String | to date
+}
+
+begin
+  
+  result = api_instance.count(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling SuppressionApi->count: #{e}"
+end
+```
+
+#### Using the count_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CountStat>, Integer, Hash)> count_with_http_info(x_sub_account_api_key, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.count_with_http_info(x_sub_account_api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CountStat>
+rescue Sendpost::ApiError => e
+  puts "Error when calling SuppressionApi->count_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
+| **from** | **String** | from date | [optional] |
+| **to** | **String** | to date | [optional] |
+
+### Return type
+
+[**CountStat**](CountStat.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_suppressions
+
+> <Array<Suppression>> create_suppressions(x_sub_account_api_key, opts)
+
+
+
+Add Email Addresses To Suppression List
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+
+api_instance = Sendpost::SuppressionApi.new
+x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
+opts = {
+  r_suppression: Sendpost::RSuppression.new # RSuppression | Suppression content
+}
+
+begin
+  
+  result = api_instance.create_suppressions(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling SuppressionApi->create_suppressions: #{e}"
+end
+```
+
+#### Using the create_suppressions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Suppression>>, Integer, Hash)> create_suppressions_with_http_info(x_sub_account_api_key, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.create_suppressions_with_http_info(x_sub_account_api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Suppression>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling SuppressionApi->create_suppressions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
+| **r_suppression** | [**RSuppression**](RSuppression.md) | Suppression content | [optional] |
+
+### Return type
+
+[**Array&lt;Suppression&gt;**](Suppression.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_suppression
+
+> <Array<DeleteResponse>> delete_suppression(x_sub_account_api_key, opts)
+
+
+
+Delete specific emails which are in suppression list
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+
+api_instance = Sendpost::SuppressionApi.new
+x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
+opts = {
+  rd_suppression: Sendpost::RDSuppression.new # RDSuppression | Suppression content
+}
+
+begin
+  
+  result = api_instance.delete_suppression(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling SuppressionApi->delete_suppression: #{e}"
+end
+```
+
+#### Using the delete_suppression_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<DeleteResponse>>, Integer, Hash)> delete_suppression_with_http_info(x_sub_account_api_key, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.delete_suppression_with_http_info(x_sub_account_api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<DeleteResponse>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling SuppressionApi->delete_suppression_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
+| **rd_suppression** | [**RDSuppression**](RDSuppression.md) | Suppression content | [optional] |
+
+### Return type
+
+[**Array&lt;DeleteResponse&gt;**](DeleteResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_suppressions
+
+> <Array<Suppression>> get_suppressions(x_sub_account_api_key, opts)
+
+
+
+Get all suppressions
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+
+api_instance = Sendpost::SuppressionApi.new
+x_sub_account_api_key = 'x_sub_account_api_key_example' # String | Sub-Account API Key
+opts = {
+  offset: 789, # Integer | offset
+  limit: 789, # Integer | limit
+  search: 'search_example', # String | search
+  from: 'from_example', # String | from date
+  to: 'to_example' # String | to date
+}
+
+begin
+  
+  result = api_instance.get_suppressions(x_sub_account_api_key, opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling SuppressionApi->get_suppressions: #{e}"
+end
+```
+
+#### Using the get_suppressions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Suppression>>, Integer, Hash)> get_suppressions_with_http_info(x_sub_account_api_key, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_suppressions_with_http_info(x_sub_account_api_key, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Suppression>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling SuppressionApi->get_suppressions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_sub_account_api_key** | **String** | Sub-Account API Key |  |
+| **offset** | **Integer** | offset | [optional] |
+| **limit** | **Integer** | limit | [optional] |
+| **search** | **String** | search | [optional] |
+| **from** | **String** | from date | [optional] |
+| **to** | **String** | to date | [optional] |
+
+### Return type
+
+[**Array&lt;Suppression&gt;**](Suppression.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SuppressionEmail.md

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

data/generate-libs.bash

@@ -1 +1 @@
-openapi-generator generate -i sendpost.yaml -g ruby -o ./ -c ./config-ruby.json
+openapi-generator generate -i sendpost.yaml -g ruby -o ./ -c ./config-ruby.json --git-repo-id sendpost_go_sdk --git-user-id sendpost

data/git_push.sh

@@ -14,12 +14,12 @@ if [ "$git_host" = "" ]; then
 fi
 
 if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
+    git_user_id="sendpost"
     echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
 fi
 
 if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
+    git_repo_id="sendpost_go_sdk"
     echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
 fi
 

data/lib/sendpost_ruby_sdk/api/email_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 Contact: hello@sendpost.io
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+OpenAPI Generator version: 7.0.1
 
 =end