Skip to content

Commit

Permalink
Merge pull request #29 from sendinblue/feature_updated_swagger_sync
Browse files Browse the repository at this point in the history 
Swagger updates for date format and some minor fixes
  • Loading branch information
@aakanksha-sib
aakanksha-sib authored Mar 19, 2019
2 parents 08ef7c6 + c9ee4fe commit 75e958d
Show file tree
Hide file tree
Showing 14 changed files with 74 additions and 84 deletions.
4 changes: 2 additions & 2 deletions docs/DeleteHardbounces.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**start_date** | **Date** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
**end_date** | **Date** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
**start_date** | **String** | Starting date (YYYY-MM-DD) of the time period for deletion. The hardbounces occurred after this date will be deleted. Must be less than or equal to the endDate | [optional]
**end_date** | **String** | Ending date (YYYY-MM-DD) of the time period for deletion. The hardbounces until this date will be deleted. Must be greater than or equal to the startDate | [optional]
**contact_email** | **String** | Target a specific email address | [optional]


7 changes: 2 additions & 5 deletions docs/SMSCampaignsApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ nil (empty response body)


# **get_sms_campaign**
> GetSmsCampaign get_sms_campaign(campaign_id, get_sms_campaign)
> GetSmsCampaign get_sms_campaign(campaign_id)
Get an SMS campaign

Expand All @@ -155,12 +155,10 @@ api_instance = SibApiV3Sdk::SMSCampaignsApi.new

campaign_id = 789 # Integer | id of the SMS campaign

get_sms_campaign = SibApiV3Sdk::GetSmsCampaign.new # GetSmsCampaign | Values to update an SMS Campaign


begin
#Get an SMS campaign
result = api_instance.get_sms_campaign(campaign_id, get_sms_campaign)
result = api_instance.get_sms_campaign(campaign_id)
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling SMSCampaignsApi->get_sms_campaign: #{e}"
Expand All @@ -172,7 +170,6 @@ end
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**campaign_id** | **Integer**| id of the SMS campaign |
**get_sms_campaign** | [**GetSmsCampaign**](GetSmsCampaign.md)| Values to update an SMS Campaign |

### Return type

Expand Down
24 changes: 12 additions & 12 deletions docs/SMTPApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ end
api_instance = SibApiV3Sdk::SMTPApi.new

opts = {
start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
tag: "tag_example" # String | Tag of the emails
}
Expand All @@ -234,8 +234,8 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**start_date** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
**end_date** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
**tag** | **String**| Tag of the emails | [optional]

Expand Down Expand Up @@ -281,8 +281,8 @@ api_instance = SibApiV3Sdk::SMTPApi.new
opts = {
limit: 50, # Integer | Number limitation for the result returned
offset: 0, # Integer | Beginning point in the list to retrieve from.
start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
email: "email_example", # String | Filter the report for a specific email addresses
event: "event_example", # String | Filter the report for a specific event type
Expand All @@ -306,8 +306,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 50]
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
**start_date** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
**end_date** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
**email** | **String**| Filter the report for a specific email addresses | [optional]
**event** | **String**| Filter the report for a specific event type | [optional]
Expand Down Expand Up @@ -357,8 +357,8 @@ api_instance = SibApiV3Sdk::SMTPApi.new
opts = {
limit: 50, # Integer | Number of documents returned per page
offset: 0, # Integer | Index of the first document on the page
start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
tag: "tag_example" # String | Tag of the emails
}
Expand All @@ -378,8 +378,8 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
**start_date** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
**end_date** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
**tag** | **String**| Tag of the emails | [optional]

Expand Down
24 changes: 12 additions & 12 deletions docs/TransactionalSMSApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ api_instance = SibApiV3Sdk::TransactionalSMSApi.new

opts = {
limit: 50, # Integer | Number of documents per page
start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
offset: 0, # Integer | Index of the first document of the page
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
phone_number: "phone_number_example", # String | Filter the report for a specific phone number
Expand All @@ -59,8 +59,8 @@ end
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| Number of documents per page | [optional] [default to 50]
**start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
**end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
**offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
**phone_number** | **String**| Filter the report for a specific phone number | [optional]
Expand Down Expand Up @@ -107,8 +107,8 @@ end
api_instance = SibApiV3Sdk::TransactionalSMSApi.new

opts = {
start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
tag: "tag_example" # String | Filter on a tag
}
Expand All @@ -126,8 +126,8 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
**end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional]
**tag** | **String**| Filter on a tag | [optional]

Expand Down Expand Up @@ -171,8 +171,8 @@ end
api_instance = SibApiV3Sdk::TransactionalSMSApi.new

opts = {
start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
tag: "tag_example" # String | Filter on a tag
}
Expand All @@ -190,8 +190,8 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
**end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
**start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional]
**end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional]
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
**tag** | **String**| Filter on a tag | [optional]

Expand Down
14 changes: 4 additions & 10 deletions lib/sib-api-v3-sdk/api/sms_campaigns_api.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,32 +132,26 @@ def delete_sms_campaign_with_http_info(campaign_id, opts = {})
# Get an SMS campaign
#
# @param campaign_id id of the SMS campaign
# @param get_sms_campaign Values to update an SMS Campaign
# @param [Hash] opts the optional parameters
# @return [GetSmsCampaign]
def get_sms_campaign(campaign_id, get_sms_campaign, opts = {})
data, _status_code, _headers = get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, opts)
def get_sms_campaign(campaign_id, opts = {})
data, _status_code, _headers = get_sms_campaign_with_http_info(campaign_id, opts)
return data
end

# Get an SMS campaign
#
# @param campaign_id id of the SMS campaign
# @param get_sms_campaign Values to update an SMS Campaign
# @param [Hash] opts the optional parameters
# @return [Array<(GetSmsCampaign, Fixnum, Hash)>] GetSmsCampaign data, response status code and response headers
def get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, opts = {})
def get_sms_campaign_with_http_info(campaign_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: SMSCampaignsApi.get_sms_campaign ..."
end
# verify the required parameter 'campaign_id' is set
if @api_client.config.client_side_validation && campaign_id.nil?
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling SMSCampaignsApi.get_sms_campaign"
end
# verify the required parameter 'get_sms_campaign' is set
if @api_client.config.client_side_validation && get_sms_campaign.nil?
fail ArgumentError, "Missing the required parameter 'get_sms_campaign' when calling SMSCampaignsApi.get_sms_campaign"
end
# resource path
local_var_path = "/smsCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)

Expand All @@ -175,7 +169,7 @@ def get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, opts = {})
form_params = {}

# http body (model)
post_body = @api_client.object_to_http_body(get_sms_campaign)
post_body = nil
auth_names = ['api-key', 'partner-key']
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
:header_params => header_params,
Expand Down
Loading

0 comments on commit 75e958d

Please sign in to comment.