docs/SMSCampaignsApi.md in sib-api-v3-sdk-2.0.1 vs docs/SMSCampaignsApi.md in sib-api-v3-sdk-2.1.0
- old
+ new
@@ -85,11 +85,11 @@
#config.api_key_prefix['api-key'] = 'Bearer'
end
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
-campaign_id = "campaign_id_example" # String | id of the SMS campaign
+campaign_id = 789 # Integer | id of the SMS campaign
begin
#Delete the SMS campaign
api_instance.delete_sms_campaigns(campaign_id)
@@ -100,11 +100,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| id of the SMS campaign |
+ **campaign_id** | **Integer**| id of the SMS campaign |
### Return type
nil (empty response body)
@@ -136,11 +136,11 @@
#config.api_key_prefix['api-key'] = 'Bearer'
end
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
-campaign_id = "campaign_id_example" # String | id of the SMS campaign
+campaign_id = 789 # Integer | id of the SMS campaign
get_sms_campaign = SibApiV3Sdk::GetSmsCampaign.new # GetSmsCampaign | Values to update an SMS Campaign
begin
@@ -154,11 +154,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| id of the SMS campaign |
+ **campaign_id** | **Integer**| id of the SMS campaign |
**get_sms_campaign** | [**GetSmsCampaign**](GetSmsCampaign.md)| Values to update an SMS Campaign |
### Return type
[**GetSmsCampaign**](GetSmsCampaign.md)
@@ -250,11 +250,11 @@
#config.api_key_prefix['api-key'] = 'Bearer'
end
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
-campaign_id = "campaign_id_example" # String | id of the campaign
+campaign_id = 789 # Integer | id of the campaign
opts = {
recipient_export: SibApiV3Sdk::RequestSMSRecipientExport.new # RequestSMSRecipientExport | Values to send for a recipient export request
}
@@ -269,11 +269,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| id of the campaign |
+ **campaign_id** | **Integer**| id of the campaign |
**recipient_export** | [**RequestSMSRecipientExport**](RequestSMSRecipientExport.md)| Values to send for a recipient export request | [optional]
### Return type
[**CreatedProcessId**](CreatedProcessId.md)
@@ -306,11 +306,11 @@
#config.api_key_prefix['api-key'] = 'Bearer'
end
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
-campaign_id = "campaign_id_example" # String | id of the campaign
+campaign_id = 789 # Integer | id of the campaign
begin
#Send your SMS campaign immediately
api_instance.send_sms_campaign_now(campaign_id)
@@ -321,11 +321,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| id of the campaign |
+ **campaign_id** | **Integer**| id of the campaign |
### Return type
nil (empty response body)
@@ -359,11 +359,11 @@
#config.api_key_prefix['api-key'] = 'Bearer'
end
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
-campaign_id = "campaign_id_example" # String | id of the campaign
+campaign_id = 789 # Integer | id of the campaign
send_report = SibApiV3Sdk::SendReport.new # SendReport | Values for send a report
begin
@@ -376,11 +376,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| id of the campaign |
+ **campaign_id** | **Integer**| id of the campaign |
**send_report** | [**SendReport**](SendReport.md)| Values for send a report |
### Return type
nil (empty response body)
@@ -413,11 +413,11 @@
#config.api_key_prefix['api-key'] = 'Bearer'
end
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
-campaign_id = "campaign_id_example" # String | Id of the SMS campaign
+campaign_id = 789 # Integer | Id of the SMS campaign
send_test_sms = SibApiV3Sdk::SendTestSms.new # SendTestSms | Mobile number to which send the test
begin
@@ -430,11 +430,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| Id of the SMS campaign |
+ **campaign_id** | **Integer**| Id of the SMS campaign |
**send_test_sms** | [**SendTestSms**](SendTestSms.md)| Mobile number to which send the test |
### Return type
nil (empty response body)
@@ -467,11 +467,11 @@
#config.api_key_prefix['api-key'] = 'Bearer'
end
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
-campaign_id = "campaign_id_example" # String | id of the SMS campaign
+campaign_id = 789 # Integer | id of the SMS campaign
update_sms_campaign = SibApiV3Sdk::UpdateSmsCampaign.new # UpdateSmsCampaign | Values to update an SMS Campaign
begin
@@ -484,11 +484,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| id of the SMS campaign |
+ **campaign_id** | **Integer**| id of the SMS campaign |
**update_sms_campaign** | [**UpdateSmsCampaign**](UpdateSmsCampaign.md)| Values to update an SMS Campaign |
### Return type
nil (empty response body)
@@ -521,11 +521,11 @@
#config.api_key_prefix['api-key'] = 'Bearer'
end
api_instance = SibApiV3Sdk::SMSCampaignsApi.new
-campaign_id = "campaign_id_example" # String | id of the campaign
+campaign_id = 789 # Integer | id of the campaign
status = SibApiV3Sdk::UpdateCampaignStatus.new # UpdateCampaignStatus | Status of the campaign.
begin
@@ -538,10 +538,10 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **campaign_id** | **String**| id of the campaign |
+ **campaign_id** | **Integer**| id of the campaign |
**status** | [**UpdateCampaignStatus**](UpdateCampaignStatus.md)| Status of the campaign. |
### Return type
nil (empty response body)