ElasticEmail 4.0.12 → 4.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdbda054427188f07760c2f3eb6e7e27892471e66338755b302ee8dbd2056e20
-  data.tar.gz: c21695fc7bf759627ba2b5e89145a1bebff7078f365f8b7dc2ab685a0b7c0c89
+  metadata.gz: 6f28babff6884dddbab9f1d2c70e05300c34ece068e515da48d87e4415d71a87
+  data.tar.gz: 6e28930bfa6c084dc484ea99e846ccbac1a9844052ec610ba45c1434ba9d7135
 SHA512:
-  metadata.gz: 2eb8cac315b968d1147e4defb925bd374ac893950b866cb2d054be050dd8ef9dd2512a71fc5ca5f7515b764bea9e8c61b0672df29061a6beaf1d174fd201bedc
-  data.tar.gz: 40389b8a3b8d520edd41686ad54cf9ec8279bbfffad13886162f0fc5a869461c3ddda6e18791ae532c95b1418b509293650716c71f78e28cfe7d77d238a8b3fd
+  metadata.gz: 6b2a09f004eebe46ce0b71285c800f64642325aba3cc01516587749e86c75fe3717526540d3cf0c23bde9f28b2a3dd71f52f488d9f2b1c2644038253acd732c2
+  data.tar.gz: 606bf59ae5d1192163699caf6bb7e6fd230b10f243bf381cc322efa287cf44ba4ac31a9d1946cfb965539dbb7e1012ed71338fb63151143bc261c410c3b41be6

data/ElasticEmail.gemspec

@@ -3,12 +3,12 @@
 =begin
 #Elastic Email REST API
 
-#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.    Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.    To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.    This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.    Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
+#This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.    Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.    The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.    To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.    This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.    Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
 
 The version of the OpenAPI document: 4.0.0
 Contact: support@elasticemail.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.1
+OpenAPI Generator version: 5.2.1
 
 =end
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["contact@elasticemail.com"]
   s.homepage    = "https://elasticemail.com"
   s.summary     = "Elastic Email REST API Ruby Gem"
-  s.description = "This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.    Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.    To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.    This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.    Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>"
+  s.description = "This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.    Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.    The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.    To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.    This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.    Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>"
   s.license     = "Unlicense"
   s.required_ruby_version = ">= 2.4"
 

data/README.md

@@ -6,16 +6,18 @@ This API is based on the REST API architecture, allowing the user to easily mana
 
 Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.
 
-To start using this API, you will need your Access Token (available <a target=\"_blank\" href=\"https://elasticemail.com/account#/settings/new/manage-api\">here</a>). Remember to keep it safe. Required access levels are listed in the given request’s description.
+The API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.
 
-This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click <a target=\"_blank\" href=\"https://api.elasticemail.com/public/help\">here</a>.
+To start using this API, you will need your Access Token (available [here](https://elasticemail.com/account#/settings/new/manage-api)). Remember to keep it safe. Required access levels are listed in the given request’s description.
 
-Downloadable library clients can be found in our Github repository <a target=\"_blank\" href=\"https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme\">here</a>
+This is the documentation for REST API. If you’d like to read our legacy documentation regarding Web API v2 click [here](https://api.elasticemail.com/public/help).
+
+Downloadable library clients can be found in our Github repository [here](https://github.com/ElasticEmail?tab=repositories&q=%22rest+api%22+in%3Areadme)
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 4.0.0
-- Package version: 4.0.12
+- Package version: 4.0.13
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -31,16 +33,16 @@ gem build ElasticEmail.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ElasticEmail-4.0.12.gem
+gem install ./ElasticEmail-4.0.13.gem
 ```
 
-(for development, run `gem install --dev ./ElasticEmail-4.0.12.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ElasticEmail-4.0.13.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ElasticEmail', '~> 4.0.12'
+    gem 'ElasticEmail', '~> 4.0.13'
 
 ### Install from Git
 

data/VERSION

@@ -1 +1 @@
-4.0.12
+4.0.13

data/docs/ApiKeyPayload.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name of the ApiKey for ease of reference. | [optional] |
-| **access_level** | [**Array<AccessLevel>**](AccessLevel.md) | Access level or permission to be assigned to this ApiKey. | [optional] |
+| **name** | **String** | Name of the ApiKey for ease of reference. |  |
+| **access_level** | [**Array<AccessLevel>**](AccessLevel.md) | Access level or permission to be assigned to this ApiKey. |  |
 | **expires** | **Time** | Date this ApiKey expires. | [optional] |
 | **restrict_access_to_ip_range** | **Array<String>** | Which IPs can use this ApiKey | [optional] |
 | **subaccount** | **String** | Email of the subaccount for which this ApiKey should be created | [optional] |

data/docs/BodyPart.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **content_type** | [**BodyContentType**](BodyContentType.md) | Type of the body part | [optional] |
+| **content_type** | [**BodyContentType**](BodyContentType.md) | Type of the body part |  |
 | **content** | **String** | Actual content of the body part | [optional] |
 | **charset** | **String** | Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more… | [optional] |
 

data/docs/Campaign.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **content** | [**Array<CampaignTemplate>**](CampaignTemplate.md) | Campaign's email content. Provide multiple items to send an A/X Split Campaign | [optional] |
-| **name** | **String** | Campaign name | [optional] |
+| **name** | **String** | Campaign name |  |
 | **status** | [**CampaignStatus**](CampaignStatus.md) | Campaign status | [optional] |
-| **recipients** | [**CampaignRecipient**](CampaignRecipient.md) | Recipients this campaign should be sent to | [optional] |
+| **recipients** | [**CampaignRecipient**](CampaignRecipient.md) | Recipients this campaign should be sent to |  |
 | **options** | [**CampaignOptions**](CampaignOptions.md) | Campaign sending options | [optional] |
 
 ## Example

data/docs/CampaignTemplate.md

@@ -23,7 +23,7 @@ instance = ElasticEmail::CampaignTemplate.new(
   reply_to: John Doe <email@domain.com>,
   subject: Hello!,
   template_name: Template01,
-  attach_files: null,
+  attach_files: [ "preuploaded.jpg" ],
   utm: null
 )
 ```

data/docs/CampaignsApi.md

@@ -175,7 +175,7 @@ end
 
 api_instance = ElasticEmail::CampaignsApi.new
 name = 'name_example' # String | Name of Campaign to update
-campaign = ElasticEmail::Campaign.new # Campaign | JSON representation of a campaign
+campaign = ElasticEmail::Campaign.new({name: 'name_example', recipients: ElasticEmail::CampaignRecipient.new}) # Campaign | JSON representation of a campaign
 
 begin
   # Update Campaign
@@ -324,7 +324,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::CampaignsApi.new
-campaign = ElasticEmail::Campaign.new # Campaign | JSON representation of a campaign
+campaign = ElasticEmail::Campaign.new({name: 'name_example', recipients: ElasticEmail::CampaignRecipient.new}) # Campaign | JSON representation of a campaign
 
 begin
   # Add Campaign

data/docs/ContactPayload.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** | Proper email address. | [optional] |
+| **email** | **String** | Proper email address. |  |
 | **status** | [**ContactStatus**](ContactStatus.md) | Status of the given resource | [optional] |
 | **first_name** | **String** | First name. | [optional] |
 | **last_name** | **String** | Last name. | [optional] |

data/docs/ContactsApi.md

@@ -702,7 +702,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::ContactsApi.new
-contact_payload = [ElasticEmail::ContactPayload.new] # Array<ContactPayload> | 
+contact_payload = [ElasticEmail::ContactPayload.new({email: 'mail@example.com'})] # Array<ContactPayload> | 
 opts = {
   listnames: ['inner_example'] # Array<String> | Names of lists to which the uploaded contacts should be added to
 }

data/docs/EmailContent.md

@@ -33,7 +33,7 @@ instance = ElasticEmail::EmailContent.new(
   reply_to: John Doe <email@domain.com>,
   subject: Hello!,
   template_name: Template01,
-  attach_files: null,
+  attach_files: [ "preuploaded.jpg" ],
   utm: null
 )
 ```

data/docs/EmailMessageData.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **recipients** | [**Array<EmailRecipient>**](EmailRecipient.md) | List of recipients (visible to others) | [optional] |
+| **recipients** | [**Array<EmailRecipient>**](EmailRecipient.md) | List of recipients (visible to others) |  |
 | **content** | [**EmailContent**](EmailContent.md) | Proper e-mail content | [optional] |
 | **options** | [**Options**](Options.md) | E-mail configuration | [optional] |
 

data/docs/EmailRecipient.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **email** | **String** | Proper email address. | [optional] |
+| **email** | **String** | Proper email address. |  |
 | **fields** | **Hash<String, String>** | A key-value collection of merge fields which can be used in e-mail body. | [optional] |
 
 ## Example

data/docs/EmailTransactionalMessageData.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **recipients** | [**TransactionalRecipient**](TransactionalRecipient.md) | List of transactional recipients | [optional] |
+| **recipients** | [**TransactionalRecipient**](TransactionalRecipient.md) | List of transactional recipients |  |
 | **content** | [**EmailContent**](EmailContent.md) | Proper e-mail content | [optional] |
 | **options** | [**Options**](Options.md) | E-mail configuration | [optional] |
 

data/docs/EmailsApi.md

@@ -103,7 +103,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-merge_email_payload = ElasticEmail::MergeEmailPayload.new # MergeEmailPayload | Email data
+merge_email_payload = ElasticEmail::MergeEmailPayload.new({merge_file: ElasticEmail::MessageAttachment.new({binary_content: 'binary_content_example'})}) # MergeEmailPayload | Email data
 
 begin
   # Send Bulk Emails CSV
@@ -174,7 +174,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-email_message_data = ElasticEmail::EmailMessageData.new # EmailMessageData | Email data
+email_message_data = ElasticEmail::EmailMessageData.new({recipients: [ElasticEmail::EmailRecipient.new({email: 'mail@example.com'})]}) # EmailMessageData | Email data
 
 begin
   # Send Bulk Emails
@@ -245,7 +245,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::EmailsApi.new
-email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new # EmailTransactionalMessageData | Email data
+email_transactional_message_data = ElasticEmail::EmailTransactionalMessageData.new({recipients: ElasticEmail::TransactionalRecipient.new({to: ['to_example']})}) # EmailTransactionalMessageData | Email data
 
 begin
   # Send Transactional Email

data/docs/EmailsPayload.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **rule** | **String** | SQL-like rule. Sending 'All' as a value loads all resources of the given type. | [optional] |
+| **rule** | **String** | SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules | [optional] |
 | **emails** | **Array<String>** | Comma delimited list of contact emails | [optional] |
 
 ## Example
@@ -14,7 +14,7 @@ require 'ElasticEmail'
 
 instance = ElasticEmail::EmailsPayload.new(
   rule: null,
-  emails: null
+  emails: [ "john.doe@sample.com" ]
 )
 ```
 

data/docs/FilePayload.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **binary_content** | **String** | Content of the file sent as binary data | [optional] |
+| **binary_content** | **String** | Content of the file sent as binary data |  |
 | **name** | **String** | Filename | [optional] |
 | **content_type** | **String** | Type of file's content (e.g. image/jpeg) | [optional] |
 

data/docs/FilesApi.md

@@ -320,7 +320,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::FilesApi.new
-file_payload = ElasticEmail::FilePayload.new # FilePayload | 
+file_payload = ElasticEmail::FilePayload.new({binary_content: 'binary_content_example'}) # FilePayload | 
 opts = {
   expires_after_days: 56 # Integer | After how many days should the file be deleted.
 }

data/docs/InboundPayload.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **filter** | **String** | Filter of the inbound data | [optional] |
-| **name** | **String** | Name of this route | [optional] |
-| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) | Type of the filter | [optional] |
-| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) | Type of action to take | [optional] |
+| **filter** | **String** | Filter of the inbound data |  |
+| **name** | **String** | Name of this route |  |
+| **filter_type** | [**InboundRouteFilterType**](InboundRouteFilterType.md) | Type of the filter |  |
+| **action_type** | [**InboundRouteActionType**](InboundRouteActionType.md) | Type of action to take |  |
 | **email_address** | **String** | Email to forward the inbound to | [optional] |
 | **http_address** | **String** | Address to notify about the inbound | [optional] |
 

data/docs/InboundRouteApi.md

@@ -176,7 +176,7 @@ end
 
 api_instance = ElasticEmail::InboundRouteApi.new
 id = 'id_example' # String | 
-inbound_payload = ElasticEmail::InboundPayload.new # InboundPayload | 
+inbound_payload = ElasticEmail::InboundPayload.new({filter: 'filter_example', name: 'name_example', filter_type: ElasticEmail::InboundRouteFilterType::EMAIL_ADDRESS, action_type: ElasticEmail::InboundRouteActionType::FORWARD_TO_EMAIL}) # InboundPayload | 
 
 begin
   # Update Route
@@ -316,7 +316,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::InboundRouteApi.new
-sort_order_item = [ElasticEmail::SortOrderItem.new] # Array<SortOrderItem> | Change the ordering of inbound routes for when matching the inbound
+sort_order_item = [ElasticEmail::SortOrderItem.new({public_inbound_id: 'public_inbound_id_example', sort_order: 37})] # Array<SortOrderItem> | Change the ordering of inbound routes for when matching the inbound
 
 begin
   # Update Sorting
@@ -387,7 +387,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::InboundRouteApi.new
-inbound_payload = ElasticEmail::InboundPayload.new # InboundPayload | 
+inbound_payload = ElasticEmail::InboundPayload.new({filter: 'filter_example', name: 'name_example', filter_type: ElasticEmail::InboundRouteFilterType::EMAIL_ADDRESS, action_type: ElasticEmail::InboundRouteActionType::FORWARD_TO_EMAIL}) # InboundPayload | 
 
 begin
   # Create Route

data/docs/ListPayload.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **list_name** | **String** | Name of your list. | [optional] |
+| **list_name** | **String** | Name of your list. |  |
 | **allow_unsubscribe** | **Boolean** | True: Allow unsubscribing from this list. Otherwise, false | [optional] |
-| **emails** | **Array<String>** | Comma delimited list of existing contact emails that should be added to this list | [optional] |
+| **emails** | **Array<String>** | Comma delimited list of existing contact emails that should be added to this list. Leave empty for all contacts | [optional] |
 
 ## Example
 

data/docs/ListsApi.md

@@ -469,7 +469,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::ListsApi.new
-list_payload = ElasticEmail::ListPayload.new # ListPayload | 
+list_payload = ElasticEmail::ListPayload.new({list_name: 'My List 1'}) # ListPayload | 
 
 begin
   # Add List

data/docs/MergeEmailPayload.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **merge_file** | [**MessageAttachment**](MessageAttachment.md) | CSV file containing recipients with optional merge fields | [optional] |
+| **merge_file** | [**MessageAttachment**](MessageAttachment.md) | CSV file containing recipients with optional merge fields |  |
 | **content** | [**EmailContent**](EmailContent.md) | Proper e-mail content | [optional] |
 | **options** | [**Options**](Options.md) | E-mail configuration | [optional] |
 

data/docs/MessageAttachment.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **binary_content** | **String** | File's content as byte array (or a Base64 string) | [optional] |
+| **binary_content** | **String** | File's content as byte array (or a Base64 string) |  |
 | **name** | **String** | Display name of the file | [optional] |
 | **content_type** | **String** | MIME content type | [optional] |
 

data/docs/SecurityApi.md

@@ -188,7 +188,7 @@ end
 
 api_instance = ElasticEmail::SecurityApi.new
 name = 'name_example' # String | Name of the ApiKey
-api_key_payload = ElasticEmail::ApiKeyPayload.new # ApiKeyPayload | 
+api_key_payload = ElasticEmail::ApiKeyPayload.new({name: 'name_example', access_level: [ElasticEmail::AccessLevel::NONE]}) # ApiKeyPayload | 
 
 begin
   # Update ApiKey
@@ -333,7 +333,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::SecurityApi.new
-api_key_payload = ElasticEmail::ApiKeyPayload.new # ApiKeyPayload | 
+api_key_payload = ElasticEmail::ApiKeyPayload.new({name: 'name_example', access_level: [ElasticEmail::AccessLevel::NONE]}) # ApiKeyPayload | 
 
 begin
   # Add ApiKey
@@ -554,7 +554,7 @@ end
 
 api_instance = ElasticEmail::SecurityApi.new
 name = 'name_example' # String | Name of the SMTP Credential
-smtp_credentials_payload = ElasticEmail::SmtpCredentialsPayload.new # SmtpCredentialsPayload | 
+smtp_credentials_payload = ElasticEmail::SmtpCredentialsPayload.new({name: 'name_example'}) # SmtpCredentialsPayload | 
 
 begin
   # Update SMTP Credential
@@ -699,7 +699,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::SecurityApi.new
-smtp_credentials_payload = ElasticEmail::SmtpCredentialsPayload.new # SmtpCredentialsPayload | 
+smtp_credentials_payload = ElasticEmail::SmtpCredentialsPayload.new({name: 'name_example'}) # SmtpCredentialsPayload | 
 
 begin
   # Add SMTP Credential

data/docs/SegmentPayload.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Segment name | [optional] |
-| **rule** | **String** | SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules | [optional] |
+| **name** | **String** | Segment name |  |
+| **rule** | **String** | SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules |  |
 
 ## Example
 

data/docs/SegmentsApi.md

@@ -175,7 +175,7 @@ end
 
 api_instance = ElasticEmail::SegmentsApi.new
 name = 'My Segment 1' # String | Name of your segment.
-segment_payload = ElasticEmail::SegmentPayload.new # SegmentPayload | 
+segment_payload = ElasticEmail::SegmentPayload.new({name: 'name_example', rule: 'rule_example'}) # SegmentPayload | 
 
 begin
   # Update Segment
@@ -322,7 +322,7 @@ ElasticEmail.configure do |config|
 end
 
 api_instance = ElasticEmail::SegmentsApi.new
-segment_payload = ElasticEmail::SegmentPayload.new # SegmentPayload | 
+segment_payload = ElasticEmail::SegmentPayload.new({name: 'name_example', rule: 'rule_example'}) # SegmentPayload | 
 
 begin
   # Add Segment

data/docs/SmtpCredentialsPayload.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Name of the Credential for ease of reference. It must be a valid email address. | [optional] |
+| **name** | **String** | Name of the Credential for ease of reference. It must be a valid email address. |  |
 | **expires** | **Time** | Date this SmtpCredential expires. | [optional] |
 | **restrict_access_to_ip_range** | **Array<String>** | Which IPs can use this SmtpCredential | [optional] |
 | **subaccount** | **String** | Email of the subaccount for which this SmtpCredential should be created | [optional] |

data/docs/SortOrderItem.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **public_inbound_id** | **String** |  | [optional] |
-| **sort_order** | **Integer** | 1 - route will be used first | [optional] |
+| **public_inbound_id** | **String** | ID of the route to change the order of |  |
+| **sort_order** | **Integer** | 1 - route will be used first |  |
 
 ## Example