sendpost_ruby_sdk 1.2.2 → 2.0.0

data/docs/IPPoolsApi.md

@@ -0,0 +1,361 @@
+# Sendpost::IPPoolsApi
+
+All URIs are relative to *https://api.sendpost.io/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_ip_pool**](IPPoolsApi.md#create_ip_pool) | **POST** /account/ippool | Create IPPool |
+| [**delete_ip_pool**](IPPoolsApi.md#delete_ip_pool) | **DELETE** /account/ippool/{ippool_id} | Delete IPPool |
+| [**get_all_ip_pools**](IPPoolsApi.md#get_all_ip_pools) | **GET** /account/ippool | List IPPools |
+| [**get_ip_pool_by_id**](IPPoolsApi.md#get_ip_pool_by_id) | **GET** /account/ippool/{ippool_id} | Get IPPool |
+| [**update_ip_pool**](IPPoolsApi.md#update_ip_pool) | **PUT** /account/ippool/{ippool_id} | Update IPPool |
+
+
+## create_ip_pool
+
+> <IPPool> create_ip_pool(ip_pool_create_request)
+
+Create IPPool
+
+Creates a new IPPool with the specified name, IPs, and third-party sending providers.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
+
+api_instance = Sendpost::IPPoolsApi.new
+ip_pool_create_request = Sendpost::IPPoolCreateRequest.new # IPPoolCreateRequest | 
+
+begin
+  # Create IPPool
+  result = api_instance.create_ip_pool(ip_pool_create_request)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->create_ip_pool: #{e}"
+end
+```
+
+#### Using the create_ip_pool_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IPPool>, Integer, Hash)> create_ip_pool_with_http_info(ip_pool_create_request)
+
+```ruby
+begin
+  # Create IPPool
+  data, status_code, headers = api_instance.create_ip_pool_with_http_info(ip_pool_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IPPool>
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->create_ip_pool_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_pool_create_request** | [**IPPoolCreateRequest**](IPPoolCreateRequest.md) |  |  |
+
+### Return type
+
+[**IPPool**](IPPool.md)
+
+### Authorization
+
+[accountAuth](../README.md#accountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_ip_pool
+
+> <IPPoolDeleteResponse> delete_ip_pool(ippool_id)
+
+Delete IPPool
+
+Delete a specific IPPool based on its ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+
+api_instance = Sendpost::IPPoolsApi.new
+ippool_id = 756 # Integer | The ID of the IPPool to delete
+
+begin
+  # Delete IPPool
+  result = api_instance.delete_ip_pool(ippool_id)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->delete_ip_pool: #{e}"
+end
+```
+
+#### Using the delete_ip_pool_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IPPoolDeleteResponse>, Integer, Hash)> delete_ip_pool_with_http_info(ippool_id)
+
+```ruby
+begin
+  # Delete IPPool
+  data, status_code, headers = api_instance.delete_ip_pool_with_http_info(ippool_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IPPoolDeleteResponse>
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->delete_ip_pool_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ippool_id** | **Integer** | The ID of the IPPool to delete |  |
+
+### Return type
+
+[**IPPoolDeleteResponse**](IPPoolDeleteResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_all_ip_pools
+
+> <Array<IPPool>> get_all_ip_pools(opts)
+
+List IPPools
+
+Retrieves a list of all IPPools and information about all IPs contained in that pool.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
+
+api_instance = Sendpost::IPPoolsApi.new
+opts = {
+  limit: 10, # Integer | Number of records to return per request
+  offset: 0, # Integer | Number of initial records to skip
+  search: 'Transactional' # String | Case insensitive search against IPPool name
+}
+
+begin
+  # List IPPools
+  result = api_instance.get_all_ip_pools(opts)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->get_all_ip_pools: #{e}"
+end
+```
+
+#### Using the get_all_ip_pools_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<IPPool>>, Integer, Hash)> get_all_ip_pools_with_http_info(opts)
+
+```ruby
+begin
+  # List IPPools
+  data, status_code, headers = api_instance.get_all_ip_pools_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<IPPool>>
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->get_all_ip_pools_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Number of records to return per request | [optional] |
+| **offset** | **Integer** | Number of initial records to skip | [optional] |
+| **search** | **String** | Case insensitive search against IPPool name | [optional] |
+
+### Return type
+
+[**Array&lt;IPPool&gt;**](IPPool.md)
+
+### Authorization
+
+[accountAuth](../README.md#accountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_ip_pool_by_id
+
+> <IPPool> get_ip_pool_by_id(ippool_id)
+
+Get IPPool
+
+Retrieves details of a specific IPPool based on its ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
+
+api_instance = Sendpost::IPPoolsApi.new
+ippool_id = 74 # Integer | The ID of the IPPool whose information you want to retrieve
+
+begin
+  # Get IPPool
+  result = api_instance.get_ip_pool_by_id(ippool_id)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->get_ip_pool_by_id: #{e}"
+end
+```
+
+#### Using the get_ip_pool_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IPPool>, Integer, Hash)> get_ip_pool_by_id_with_http_info(ippool_id)
+
+```ruby
+begin
+  # Get IPPool
+  data, status_code, headers = api_instance.get_ip_pool_by_id_with_http_info(ippool_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IPPool>
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->get_ip_pool_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ippool_id** | **Integer** | The ID of the IPPool whose information you want to retrieve |  |
+
+### Return type
+
+[**IPPool**](IPPool.md)
+
+### Authorization
+
+[accountAuth](../README.md#accountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_ip_pool
+
+> <IPPool> update_ip_pool(ip_pool_update_request, ippool_id)
+
+Update IPPool
+
+Update the details of an existing IPPool by its ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+
+api_instance = Sendpost::IPPoolsApi.new
+ip_pool_update_request = Sendpost::IPPoolUpdateRequest.new # IPPoolUpdateRequest | 
+ippool_id = 756 # Integer | The ID of the IPPool to update
+
+begin
+  # Update IPPool
+  result = api_instance.update_ip_pool(ip_pool_update_request, ippool_id)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->update_ip_pool: #{e}"
+end
+```
+
+#### Using the update_ip_pool_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IPPool>, Integer, Hash)> update_ip_pool_with_http_info(ip_pool_update_request, ippool_id)
+
+```ruby
+begin
+  # Update IPPool
+  data, status_code, headers = api_instance.update_ip_pool_with_http_info(ip_pool_update_request, ippool_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IPPool>
+rescue Sendpost::ApiError => e
+  puts "Error when calling IPPoolsApi->update_ip_pool_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip_pool_update_request** | [**IPPoolUpdateRequest**](IPPoolUpdateRequest.md) |  |  |
+| **ippool_id** | **Integer** | The ID of the IPPool to update |  |
+
+### Return type
+
+[**IPPool**](IPPool.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/IPUpdateRequest.md

@@ -0,0 +1,18 @@
+# Sendpost::IPUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auto_warmup_enabled** | **Boolean** | Whether the IP warmup should happen automatically or be managed manually |  |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::IPUpdateRequest.new(
+  auto_warmup_enabled: false
+)
+```
+

data/docs/Label.md

@@ -0,0 +1,22 @@
+# Sendpost::Label
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unique ID for the label | [optional] |
+| **name** | **String** | Name of the label | [optional] |
+| **created** | **Integer** | UNIX epoch nano timestamp when the label was created | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::Label.new(
+  id: 325,
+  name: Free Tier,
+  created: 1685427871489941179
+)
+```
+

data/docs/Member.md

@@ -0,0 +1,40 @@
+# Sendpost::Member
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unique ID for the member | [optional] |
+| **is_verified** | **Boolean** | Indicates whether the member is verified | [optional] |
+| **is_forbidden** | **Boolean** | Indicates whether the member is forbidden | [optional] |
+| **firebase_uid** | **String** | Firebase UID for the member | [optional] |
+| **email** | **String** | Email for the member | [optional] |
+| **name** | **String** | Name for the member | [optional] |
+| **url** | **String** | Logo URL for the member | [optional] |
+| **company_name** | **String** | Company name for the member | [optional] |
+| **onboard_q_answered** | **Boolean** | Indicates whether the member has answered onboarding question | [optional] |
+| **phone_number** | **String** | Phone number for the member | [optional] |
+| **notes_color** | **String** | Color for the member's notes | [optional] |
+| **created** | **Integer** | UNIX epoch nano timestamp when the member was created | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::Member.new(
+  id: 117,
+  is_verified: true,
+  is_forbidden: false,
+  firebase_uid: 1234567890,
+  email: raj@piedpiper.com,
+  name: Raj,
+  url: https://www.sendpost.io/logo.png,
+  company_name: SendPost,
+  onboard_q_answered: true,
+  phone_number: +919876543210,
+  notes_color: #000000,
+  created: 1567512491588004044
+)
+```
+

data/docs/Message.md

@@ -0,0 +1,76 @@
+# Sendpost::Message
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **String** | Unique ID for the message. | [optional] |
+| **account_id** | **Integer** | Account ID associated with the message. | [optional] |
+| **sub_account_id** | **Integer** | Sub-account ID associated with the message. | [optional] |
+| **ip_id** | **Integer** | IP ID used for sending the message. | [optional] |
+| **account_ip_pool_id** | **Integer** | Account IP Pool ID associated with the message. | [optional] |
+| **public_ip** | **String** | Public IP address used for sending the message. | [optional] |
+| **local_ip** | **String** | Local IP address used for sending the message. | [optional] |
+| **email_type** | **String** | Type of email service used. | [optional] |
+| **submitted_at** | **Integer** | UNIX epoch nano timestamp when message was submitted. | [optional] |
+| **from** | [**Person**](.md) | Object comprising name and email address of the sender | [optional] |
+| **reply_to** | [**Person**](.md) | Object comprising name and email addresses to which email replies will go to | [optional] |
+| **to** | [**MessageTo**](MessageTo.md) |  | [optional] |
+| **header_to** | [**MessageHeaderTo**](MessageHeaderTo.md) |  | [optional] |
+| **header_cc** | **Array<String>** | List of CC recipients from email headers | [optional] |
+| **header_bcc** | **Array<String>** | List of BCC recipients from email headers | [optional] |
+| **attachments** | **Array<String>** | List of attachments | [optional] |
+| **groups** | **Array<String>** | List of groups associated with the message | [optional] |
+| **ip_pool** | **String** | IP Pool from which emails will go out. Relevant only for customers on dedicated IP plans. | [optional] |
+| **headers** | **Hash<String, String>** | Key-Value pair which are added to every email message being sent and also with webhooks triggered on events such as email delivered, open, click etc. They are useful to identify email, recipient etc. in your internal system | [optional] |
+| **custom_fields** | **Hash<String, String>** | Key-Value pair of custom fields at message level | [optional] |
+| **subject** | **String** | Email subject line. | [optional] |
+| **pre_text** | **String** | Text which appears on mobile right after email subject line. | [optional] |
+| **html_body** | **String** | HTML email content. | [optional] |
+| **text_body** | **String** | Text email content. | [optional] |
+| **amp_body** | **String** | AMP email content. | [optional] |
+| **track_opens** | **Boolean** | Indicates if email opens need to be tracked. | [optional] |
+| **track_clicks** | **Boolean** | Indicates if email clicks need to be tracked. | [optional] |
+| **attempt** | **Integer** | Number of delivery attempts made for the message. | [optional] |
+| **webhook_endpoint** | **String** | Webhook endpoint URL for the message. | [optional] |
+| **mx_records** | **Array<String>** | List of MX records for the recipient domain | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::Message.new(
+  message_id: c486c7e5-4b0b-4ce5-b392-6ac2a453dcb6,
+  account_id: 1837,
+  sub_account_id: 46499,
+  ip_id: 46,
+  account_ip_pool_id: 0,
+  public_ip: 34.196.37.102,
+  local_ip: 10.1.0.195,
+  email_type: googleworkspace,
+  submitted_at: 1766396394503841392,
+  from: null,
+  reply_to: null,
+  to: null,
+  header_to: null,
+  header_cc: [],
+  header_bcc: null,
+  attachments: [],
+  groups: [],
+  ip_pool: ,
+  headers: {X-SendPost-Mock-Email=, X-SendPost-Mock-Time-Shift=},
+  custom_fields: {},
+  subject: Test Email from SendPost Java SDK,
+  pre_text: ,
+  html_body: <h1>Hello from SendPost!</h1><p>This is a test email sent using the SendPost Java SDK from Maven Central.</p>,
+  text_body: Hello from SendPost! This is a test email sent using the SendPost Java SDK from Maven Central.,
+  amp_body: ,
+  track_opens: true,
+  track_clicks: true,
+  attempt: 0,
+  webhook_endpoint: ,
+  mx_records: [alt3.aspmx.l.google.com, alt4.aspmx.l.google.com, alt1.aspmx.l.google.com, alt2.aspmx.l.google.com, aspmx.l.google.com]
+)
+```
+

data/docs/MessageApi.md

@@ -0,0 +1,79 @@
+# Sendpost::MessageApi
+
+All URIs are relative to *https://api.sendpost.io/api/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_message_by_id**](MessageApi.md#get_message_by_id) | **GET** /account/message/{message_id} | Get Message |
+
+
+## get_message_by_id
+
+> <Message> get_message_by_id(message_id)
+
+Get Message
+
+Retrieve detailed information about a specific message by its ID.
+
+### Examples
+
+```ruby
+require 'time'
+require 'sendpost_ruby_sdk'
+# setup authorization
+Sendpost.configure do |config|
+  # Configure API key authorization: accountAuth
+  config.api_key['X-Account-ApiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Account-ApiKey'] = 'Bearer'
+end
+
+api_instance = Sendpost::MessageApi.new
+message_id = 'message_id_example' # String | The ID of the message to retrieve.
+
+begin
+  # Get Message
+  result = api_instance.get_message_by_id(message_id)
+  p result
+rescue Sendpost::ApiError => e
+  puts "Error when calling MessageApi->get_message_by_id: #{e}"
+end
+```
+
+#### Using the get_message_by_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Message>, Integer, Hash)> get_message_by_id_with_http_info(message_id)
+
+```ruby
+begin
+  # Get Message
+  data, status_code, headers = api_instance.get_message_by_id_with_http_info(message_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Message>
+rescue Sendpost::ApiError => e
+  puts "Error when calling MessageApi->get_message_by_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **String** | The ID of the message to retrieve. |  |
+
+### Return type
+
+[**Message**](Message.md)
+
+### Authorization
+
+[accountAuth](../README.md#accountAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MessageHeaderTo.md

@@ -0,0 +1,26 @@
+# Sendpost::MessageHeaderTo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the recipient. | [optional] |
+| **email** | **String** | Email address of the recipient. | [optional] |
+| **cc** | **Array<String>** | List of CC recipients | [optional] |
+| **bcc** | **Array<String>** | List of BCC recipients | [optional] |
+| **custom_fields** | **Hash<String, String>** | Key-Value pair of custom fields. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::MessageHeaderTo.new(
+  name: Test Recipient,
+  email: aditya@sendx.io,
+  cc: [],
+  bcc: [],
+  custom_fields: {}
+)
+```
+

data/docs/MessageTo.md

@@ -0,0 +1,26 @@
+# Sendpost::MessageTo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the recipient. | [optional] |
+| **email** | **String** | Email address of the recipient. | [optional] |
+| **cc** | **Array<String>** | List of CC recipients | [optional] |
+| **bcc** | **Array<String>** | List of BCC recipients | [optional] |
+| **custom_fields** | **Hash<String, String>** | Key-Value pair of custom fields. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::MessageTo.new(
+  name: Test Recipient,
+  email: aditya@sendx.io,
+  cc: [],
+  bcc: [],
+  custom_fields: {}
+)
+```
+

data/docs/{Os.md → OperatingSystem.md}

@@ -1,4 +1,4 @@
-# Sendpost::Os
+# Sendpost::OperatingSystem
 
 ## Properties
 
@@ -15,12 +15,12 @@
 ```ruby
 require 'sendpost_ruby_sdk'
 
-instance = Sendpost::Os.new(
-  family: null,
-  major: null,
-  minor: null,
-  patch: null,
-  patch_minor: null
+instance = Sendpost::OperatingSystem.new(
+  family: Windows,
+  major: 10,
+  minor: 0,
+  patch: 0,
+  patch_minor: 0
 )
 ```
 

data/docs/Person.md

@@ -0,0 +1,20 @@
+# Sendpost::Person
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the person. | [optional] |
+| **email** | **String** | Email address of the person. | [optional] |
+
+## Example
+
+```ruby
+require 'sendpost_ruby_sdk'
+
+instance = Sendpost::Person.new(
+  name: PiedPipers,
+  email: team@piedpiper.com
+)
+```
+