Skip to content

Commit 75e958d

Browse files
aakanksha-sibaakanksha-sib
authored
Merge pull request sendinblue#29 from sendinblue/feature_updated_swagger_sync
Swagger updates for date format and some minor fixes
2 parents 08ef7c6 + c9ee4fe commit 75e958d

14 files changed

+74
-84
lines changed

‎docs/DeleteHardbounces.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**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]
7-
**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]
6+
**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]
7+
**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]
88
**contact_email** | **String** | Target a specific email address | [optional]
99

1010

‎docs/SMSCampaignsApi.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ nil (empty response body)
130130

131131

132132
# **get_sms_campaign**
133-
> GetSmsCampaign get_sms_campaign(campaign_id, get_sms_campaign)
133+
> GetSmsCampaign get_sms_campaign(campaign_id)
134134
135135
Get an SMS campaign
136136

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

156156
campaign_id = 789 # Integer | id of the SMS campaign
157157

158-
get_sms_campaign = SibApiV3Sdk::GetSmsCampaign.new # GetSmsCampaign | Values to update an SMS Campaign
159-
160158

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

177174
### Return type
178175

‎docs/SMTPApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -215,8 +215,8 @@ end
215215
api_instance = SibApiV3Sdk::SMTPApi.new
216216

217217
opts = {
218-
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
219-
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
218+
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
219+
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
220220
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
221221
tag: "tag_example" # String | Tag of the emails
222222
}
@@ -234,8 +234,8 @@ end
234234

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

@@ -281,8 +281,8 @@ api_instance = SibApiV3Sdk::SMTPApi.new
281281
opts = {
282282
limit: 50, # Integer | Number limitation for the result returned
283283
offset: 0, # Integer | Beginning point in the list to retrieve from.
284-
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
285-
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
284+
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
285+
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
286286
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
287287
email: "email_example", # String | Filter the report for a specific email addresses
288288
event: "event_example", # String | Filter the report for a specific event type
@@ -306,8 +306,8 @@ Name | Type | Description | Notes
306306
------------- | ------------- | ------------- | -------------
307307
**limit** | **Integer**| Number limitation for the result returned | [optional] [default to 50]
308308
**offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
309-
**start_date** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
310-
**end_date** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
309+
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
310+
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
311311
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
312312
**email** | **String**| Filter the report for a specific email addresses | [optional]
313313
**event** | **String**| Filter the report for a specific event type | [optional]
@@ -357,8 +357,8 @@ api_instance = SibApiV3Sdk::SMTPApi.new
357357
opts = {
358358
limit: 50, # Integer | Number of documents returned per page
359359
offset: 0, # Integer | Index of the first document on the page
360-
start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
361-
end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
360+
start_date: "start_date_example", # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
361+
end_date: "end_date_example", # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
362362
days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
363363
tag: "tag_example" # String | Tag of the emails
364364
}
@@ -378,8 +378,8 @@ Name | Type | Description | Notes
378378
------------- | ------------- | ------------- | -------------
379379
**limit** | **Integer**| Number of documents returned per page | [optional] [default to 50]
380380
**offset** | **Integer**| Index of the first document on the page | [optional] [default to 0]
381-
**start_date** | **Date**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
382-
**end_date** | **Date**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
381+
**start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD) | [optional]
382+
**end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD) | [optional]
383383
**days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional]
384384
**tag** | **String**| Tag of the emails | [optional]
385385

‎docs/TransactionalSMSApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ api_instance = SibApiV3Sdk::TransactionalSMSApi.new
3636

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

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

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

@@ -171,8 +171,8 @@ end
171171
api_instance = SibApiV3Sdk::TransactionalSMSApi.new
172172

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

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

‎lib/sib-api-v3-sdk/api/sms_campaigns_api.rb

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -132,32 +132,26 @@ def delete_sms_campaign_with_http_info(campaign_id, opts = {})
132132
# Get an SMS campaign
133133
#
134134
# @param campaign_id id of the SMS campaign
135-
# @param get_sms_campaign Values to update an SMS Campaign
136135
# @param [Hash] opts the optional parameters
137136
# @return [GetSmsCampaign]
138-
def get_sms_campaign(campaign_id, get_sms_campaign, opts = {})
139-
data, _status_code, _headers = get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, opts)
137+
def get_sms_campaign(campaign_id, opts = {})
138+
data, _status_code, _headers = get_sms_campaign_with_http_info(campaign_id, opts)
140139
return data
141140
end
142141

143142
# Get an SMS campaign
144143
#
145144
# @param campaign_id id of the SMS campaign
146-
# @param get_sms_campaign Values to update an SMS Campaign
147145
# @param [Hash] opts the optional parameters
148146
# @return [Array<(GetSmsCampaign, Fixnum, Hash)>] GetSmsCampaign data, response status code and response headers
149-
def get_sms_campaign_with_http_info(campaign_id, get_sms_campaign, opts = {})
147+
def get_sms_campaign_with_http_info(campaign_id, opts = {})
150148
if @api_client.config.debugging
151149
@api_client.config.logger.debug "Calling API: SMSCampaignsApi.get_sms_campaign ..."
152150
end
153151
# verify the required parameter 'campaign_id' is set
154152
if @api_client.config.client_side_validation && campaign_id.nil?
155153
fail ArgumentError, "Missing the required parameter 'campaign_id' when calling SMSCampaignsApi.get_sms_campaign"
156154
end
157-
# verify the required parameter 'get_sms_campaign' is set
158-
if @api_client.config.client_side_validation && get_sms_campaign.nil?
159-
fail ArgumentError, "Missing the required parameter 'get_sms_campaign' when calling SMSCampaignsApi.get_sms_campaign"
160-
end
161155
# resource path
162156
local_var_path = "/smsCampaigns/{campaignId}".sub('{' + 'campaignId' + '}', campaign_id.to_s)
163157

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

177171
# http body (model)
178-
post_body = @api_client.object_to_http_body(get_sms_campaign)
172+
post_body = nil
179173
auth_names = ['api-key', 'partner-key']
180174
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
181175
:header_params => header_params,

0 commit comments

Comments
 (0)