Skip to content

Commit

Permalink
Merge pull request #49 from sendinblue/feature_swagger_sync_new
Browse files Browse the repository at this point in the history
Feature swagger sync new
  • Loading branch information
aakanksha-sib authored Dec 30, 2020
2 parents 2a9d7ed + e41abcd commit a6624a7
Show file tree
Hide file tree
Showing 73 changed files with 1,258 additions and 290 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,13 @@ Class | Method | HTTP request | Description
*SibApiV3Sdk::SendersApi* | [**get_ips_from_sender**](docs/SendersApi.md#get_ips_from_sender) | **GET** /senders/{senderId}/ips | Get all the dedicated IPs for a sender
*SibApiV3Sdk::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Get the list of all your senders
*SibApiV3Sdk::SendersApi* | [**update_sender**](docs/SendersApi.md#update_sender) | **PUT** /senders/{senderId} | Update a sender
*SibApiV3Sdk::TransactionalEmailsApi* | [**block_new_domain**](docs/TransactionalEmailsApi.md#block_new_domain) | **POST** /smtp/blockedDomains | Add a new domain to the list of blocked domains
*SibApiV3Sdk::TransactionalEmailsApi* | [**create_smtp_template**](docs/TransactionalEmailsApi.md#create_smtp_template) | **POST** /smtp/templates | Create an email template
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_blocked_domain**](docs/TransactionalEmailsApi.md#delete_blocked_domain) | **DELETE** /smtp/blockedDomains/{domain} | Unblock an existing domain from the list of blocked domains
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_hardbounces**](docs/TransactionalEmailsApi.md#delete_hardbounces) | **POST** /smtp/deleteHardbounces | Delete hardbounces
*SibApiV3Sdk::TransactionalEmailsApi* | [**delete_smtp_template**](docs/TransactionalEmailsApi.md#delete_smtp_template) | **DELETE** /smtp/templates/{templateId} | Delete an inactive email template
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_aggregated_smtp_report**](docs/TransactionalEmailsApi.md#get_aggregated_smtp_report) | **GET** /smtp/statistics/aggregatedReport | Get your transactional email activity aggregated over a period of time
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_blocked_domains**](docs/TransactionalEmailsApi.md#get_blocked_domains) | **GET** /smtp/blockedDomains | Get the list of blocked domains
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_email_event_report**](docs/TransactionalEmailsApi.md#get_email_event_report) | **GET** /smtp/statistics/events | Get all your transactional email activity (unaggregated events)
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_report**](docs/TransactionalEmailsApi.md#get_smtp_report) | **GET** /smtp/statistics/reports | Get your transactional email activity aggregated per day
*SibApiV3Sdk::TransactionalEmailsApi* | [**get_smtp_template**](docs/TransactionalEmailsApi.md#get_smtp_template) | **GET** /smtp/templates/{templateId} | Returns the template information
Expand Down Expand Up @@ -217,6 +220,7 @@ Class | Method | HTTP request | Description
- [SibApiV3Sdk::AddChildDomain](docs/AddChildDomain.md)
- [SibApiV3Sdk::AddContactToList](docs/AddContactToList.md)
- [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
- [SibApiV3Sdk::BlockDomain](docs/BlockDomain.md)
- [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
- [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
- [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
Expand Down Expand Up @@ -251,6 +255,7 @@ Class | Method | HTTP request | Description
- [SibApiV3Sdk::GetAttributes](docs/GetAttributes.md)
- [SibApiV3Sdk::GetAttributesAttributes](docs/GetAttributesAttributes.md)
- [SibApiV3Sdk::GetAttributesEnumeration](docs/GetAttributesEnumeration.md)
- [SibApiV3Sdk::GetBlockedDomains](docs/GetBlockedDomains.md)
- [SibApiV3Sdk::GetCampaignOverview](docs/GetCampaignOverview.md)
- [SibApiV3Sdk::GetCampaignRecipients](docs/GetCampaignRecipients.md)
- [SibApiV3Sdk::GetCampaignStats](docs/GetCampaignStats.md)
Expand Down
8 changes: 8 additions & 0 deletions docs/BlockDomain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# SibApiV3Sdk::BlockDomain

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**domain** | **String** | name of the domain to be blocked |


24 changes: 18 additions & 6 deletions docs/ContactsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -807,7 +807,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new
opts = {
limit: 50, # Integer | Number of documents per page
offset: 0, # Integer | Index of the first document of the page
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
}

begin
Expand All @@ -826,6 +827,7 @@ Name | Type | Description | Notes
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -871,7 +873,8 @@ list_id = 789 # Integer | Id of the list
opts = {
modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
limit: 50, # Integer | Number of documents per page
offset: 0 # Integer | Index of the first document of the page
offset: 0, # Integer | Index of the first document of the page
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
}

begin
Expand All @@ -891,6 +894,7 @@ Name | Type | Description | Notes
**modified_since** | **DateTime**| Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. | [optional]
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -992,7 +996,8 @@ folder_id = 789 # Integer | Id of the folder

opts = {
limit: 10, # Integer | Number of documents per page
offset: 0 # Integer | Index of the first document of the page
offset: 0, # Integer | Index of the first document of the page
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
}

begin
Expand All @@ -1011,6 +1016,7 @@ Name | Type | Description | Notes
**folder_id** | **Integer**| Id of the folder |
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]

### Return type

Expand All @@ -1028,7 +1034,7 @@ Name | Type | Description | Notes


# **get_folders**
> GetFolders get_folders(limit, offset)
> GetFolders get_folders(limit, offset, opts)
Get all folders

Expand All @@ -1055,10 +1061,13 @@ limit = 10 # Integer | Number of documents per page

offset = 0 # Integer | Index of the first document of the page

opts = {
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
}

begin
#Get all folders
result = api_instance.get_folders(limit, offset)
result = api_instance.get_folders(limit, offset, opts)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling ContactsApi->get_folders: #{e}"
Expand All @@ -1071,6 +1080,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| Number of documents per page | [default to 10]
**offset** | **Integer**| Index of the first document of the page | [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]

### Return type

Expand Down Expand Up @@ -1170,7 +1180,8 @@ api_instance = SibApiV3Sdk::ContactsApi.new

opts = {
limit: 10, # Integer | Number of documents per page
offset: 0 # Integer | Index of the first document of the page
offset: 0, # Integer | Index of the first document of the page
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
}

begin
Expand All @@ -1188,6 +1199,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]

### Return type

Expand Down
2 changes: 1 addition & 1 deletion docs/CreateSmtpTemplateSender.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of the sender. If not passed, will be set to default | [optional]
**email** | **String** | Email of the sender |
**email** | **String** | Email of the sender | [optional]
**id** | **Integer** | Select the sender for the template on the basis of sender id. In order to select a sender with specific pool of IP’s, dedicated ip users shall pass id (instead of email). | [optional]


4 changes: 3 additions & 1 deletion docs/EmailCampaignsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,8 @@ opts = {
start_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )
limit: 500, # Integer | Number of documents per page
offset: 0 # Integer | Index of the first document in the page
offset: 0, # Integer | Index of the first document in the page
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
}

begin
Expand All @@ -361,6 +362,7 @@ Name | Type | Description | Notes
**end_date** | **DateTime**| Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' ) | [optional]
**limit** | **Integer**| Number of documents per page | [optional] [default to 500]
**offset** | **Integer**| Index of the first document in the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]

### Return type

Expand Down
12 changes: 9 additions & 3 deletions docs/FoldersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,8 @@ folder_id = 789 # Integer | Id of the folder

opts = {
limit: 10, # Integer | Number of documents per page
offset: 0 # Integer | Index of the first document of the page
offset: 0, # Integer | Index of the first document of the page
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
}

begin
Expand All @@ -229,6 +230,7 @@ Name | Type | Description | Notes
**folder_id** | **Integer**| Id of the folder |
**limit** | **Integer**| Number of documents per page | [optional] [default to 10]
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]

### Return type

Expand All @@ -246,7 +248,7 @@ Name | Type | Description | Notes


# **get_folders**
> GetFolders get_folders(limit, offset)
> GetFolders get_folders(limit, offset, opts)
Get all folders

Expand All @@ -273,10 +275,13 @@ limit = 10 # Integer | Number of documents per page

offset = 0 # Integer | Index of the first document of the page

opts = {
sort: 'desc' # String | Sort the results in the ascending/descending order of record creation
}

begin
#Get all folders
result = api_instance.get_folders(limit, offset)
result = api_instance.get_folders(limit, offset, opts)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling FoldersApi->get_folders: #{e}"
Expand All @@ -289,6 +294,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| Number of documents per page | [default to 10]
**offset** | **Integer**| Index of the first document of the page | [default to 0]
**sort** | **String**| Sort the results in the ascending/descending order of record creation | [optional] [default to desc]

### Return type

Expand Down
8 changes: 8 additions & 0 deletions docs/GetBlockedDomains.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# SibApiV3Sdk::GetBlockedDomains

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**domains** | **Array<String>** | List of all blocked domains |


4 changes: 2 additions & 2 deletions docs/GetChildDomain.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**domain** | **String** | Sender domain |
**active** | **BOOLEAN** | indicates whether a domain is verified or not |
**domain** | **String** | Sender domain | [optional]
**active** | **BOOLEAN** | indicates whether a domain is verified or not | [optional]


2 changes: 1 addition & 1 deletion docs/GetChildrenList.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**children** | **Array<Object>** | Your children's account information | [optional]
**count** | **Integer** | Number of child accounts |
**count** | **Integer** | Number of child accounts | [optional]


4 changes: 2 additions & 2 deletions docs/GetEmailCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Name | Type | Description | Notes
**footer** | **String** | Footer of the campaign |
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
**to_field** | **String** | Customisation of the \"to\" field of the campaign | [optional]
**html_content** | **String** | HTML content of the campaign |
**share_link** | **String** | Link to share the campaign on social medias | [optional]
**tag** | **String** | Tag of the campaign |
**tag** | **String** | Tag of the campaign | [optional]
**created_at** | **DateTime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/GetEmailCampaigns.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaigns** | **Array<Object>** | | [optional]
**count** | **Integer** | Number of Email campaigns retrieved |
**count** | **Integer** | Number of Email campaigns retrieved | [optional]


1 change: 1 addition & 0 deletions docs/GetEmailEventReportEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,6 @@ Name | Type | Description | Notes
**ip** | **String** | IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks) | [optional]
**link** | **String** | The link which is sent to the user (only available if the event is requests or opened or clicks) | [optional]
**from** | **String** | Sender email from which the emails are sent | [optional]
**template_id** | **Integer** | ID of the template (only available if the email is template based) | [optional]


4 changes: 2 additions & 2 deletions docs/GetExtendedCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ Name | Type | Description | Notes
**footer** | **String** | Footer of the campaign |
**sender** | [**GetExtendedCampaignOverviewSender**](GetExtendedCampaignOverviewSender.md) | |
**reply_to** | **String** | Email defined as the \"Reply to\" of the campaign |
**to_field** | **String** | Customisation of the \"to\" field of the campaign |
**to_field** | **String** | Customisation of the \"to\" field of the campaign | [optional]
**html_content** | **String** | HTML content of the campaign |
**share_link** | **String** | Link to share the campaign on social medias | [optional]
**tag** | **String** | Tag of the campaign |
**tag** | **String** | Tag of the campaign | [optional]
**created_at** | **DateTime** | Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/GetFolderLists.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**lists** | **Array<Object>** | |
**count** | **Integer** | Number of lists in the folder |
**lists** | **Array<Object>** | | [optional]
**count** | **Integer** | Number of lists in the folder | [optional]


4 changes: 2 additions & 2 deletions docs/GetLists.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**lists** | **Array<Object>** | Listing of all the lists available in your account |
**count** | **Integer** | Number of lists in your account |
**lists** | **Array<Object>** | Listing of all the lists available in your account | [optional]
**count** | **Integer** | Number of lists in your account | [optional]


2 changes: 1 addition & 1 deletion docs/GetProcesses.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**processes** | [**Array<GetProcess>**](GetProcess.md) | List of processes available on your account | [optional]
**count** | **Integer** | Number of processes available on your account |
**count** | **Integer** | Number of processes available on your account | [optional]


2 changes: 1 addition & 1 deletion docs/GetSmsCampaign.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the SMS Campaign |
**status** | **String** | Status of the SMS Campaign |
**content** | **String** | Content of the SMS Campaign |
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
**sender** | **String** | Sender of the SMS Campaign |
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
Expand Down
2 changes: 1 addition & 1 deletion docs/GetSmsCampaignOverview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Name | Type | Description | Notes
**name** | **String** | Name of the SMS Campaign |
**status** | **String** | Status of the SMS Campaign |
**content** | **String** | Content of the SMS Campaign |
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format |
**scheduled_at** | **DateTime** | UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format | [optional]
**sender** | **String** | Sender of the SMS Campaign |
**created_at** | **DateTime** | Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
**modified_at** | **DateTime** | UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ) |
Expand Down
Loading

0 comments on commit a6624a7

Please sign in to comment.