Automated release 1.0 (#8)

* Auto-update * Auto-update * Auto-update * Auto-update * Removed old models (#9) Updated old model names to new ones in TM Api Tests * Auto-update * Auto-update
salesforce-marketingcloud · Nov 22, 2019 · 9781104 · 9781104
1 parent 5024d05
commit 9781104
Show file tree

Hide file tree

Showing 28 changed files with 316 additions and 1,514 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/EmailDefinition.md b/docs/EmailDefinition.md
@@ -0,0 +1,19 @@
+# SalesforceMarketingCloud.EmailDefinition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requestId** | **String** | The ID of the request | [optional] 
+**name** | **String** | Name of the definition. Must be unique. | 
+**definitionKey** | **String** | Unique, user-generated key to access the definition object. | 
+**definitionId** | **String** | Definition Id | [optional] 
+**description** | **String** | User-provided description of the email definition. | [optional] 
+**classification** | **String** | Marketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional. | [optional] 
+**status** | **String** | Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days. | [optional] 
+**createdDate** | **Date** | The date the object was created. | [optional] 
+**modifiedDate** | **Date** | The date the object was modified. | [optional] 
+**content** | [**EmailDefinitionContent**](EmailDefinitionContent.md) |  | 
+**subscriptions** | [**EmailDefinitionSubscriptions**](EmailDefinitionSubscriptions.md) |  | 
+**options** | [**EmailDefinitionOptions**](EmailDefinitionOptions.md) |  | [optional] 
+
+
diff --git a/docs/EmailDefinitionContent.md b/docs/EmailDefinitionContent.md
@@ -0,0 +1,8 @@
+# SalesforceMarketingCloud.EmailDefinitionContent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customerKey** | **String** | Unique identifier of the content asset. | 
+
+
diff --git a/docs/EmailDefinitionOptions.md b/docs/EmailDefinitionOptions.md
@@ -0,0 +1,8 @@
+# SalesforceMarketingCloud.EmailDefinitionOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**trackLinks** | **Boolean** | Wraps links for tracking and reporting. Default is true. | [optional] 
+
+
diff --git a/docs/EmailDefinitionSubscriptions.md b/docs/EmailDefinitionSubscriptions.md
@@ -0,0 +1,11 @@
+# SalesforceMarketingCloud.EmailDefinitionSubscriptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list** | **String** | Marketing Cloud external key of the list or all subscribers. Contains the subscriber keys and profile attributes. | 
+**dataExtension** | **String** | Marketing Cloud external key of the triggered send data extension. Each request inserts as a new row in the data extension. | [optional] 
+**autoAddSubscriber** | **Boolean** | Adds the recipient’s email address and contact key as a subscriber key to subscriptions.list. Default is true. | [optional] [default to true]
+**updateSubscriber** | **Boolean** | Updates the recipient’s contact key as a subscriber key with the provided email address and profile attributes to subscriptions.list. Default is true. | [optional] 
+
+
diff --git a/docs/GetEmailDefinitionsResponse.md b/docs/GetEmailDefinitionsResponse.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **requestId** | **String** | The ID of the request | [optional] 
-**definitions** | [**[CreateEmailDefinitionRequest]**](CreateEmailDefinitionRequest.md) |  | [optional] 
+**definitions** | [**[EmailDefinition]**](EmailDefinition.md) |  | [optional] 
 **count** | **Number** | Number of pages | [optional] 
 **page** | **Number** | Page number to return. | [optional] 
 **pageSize** | **Number** | Number of definitions, which are array elements, to return per paged response. | [optional] 

diff --git a/docs/GetSmsDefinitionsResponse.md b/docs/GetSmsDefinitionsResponse.md
@@ -4,7 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **requestId** | **String** | The ID of the request | [optional] 
-**definitions** | [**[CreateSmsDefinitionRequest]**](CreateSmsDefinitionRequest.md) |  | [optional] 
+**definitions** | [**[SmsDefinition]**](SmsDefinition.md) |  | [optional] 
 **count** | **Number** | Number of pages | [optional] 
 **page** | **Number** | Page number to return. | [optional] 
 **pageSize** | **Number** | Number of definitions, which are array elements, to return per paged response. | [optional] 

diff --git a/docs/SmsDefinition.md b/docs/SmsDefinition.md
@@ -0,0 +1,16 @@
+# SalesforceMarketingCloud.SmsDefinition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**definitionKey** | **String** | Unique, user-generated key to access the definition object. | 
+**name** | **String** | Name of the definition. Must be unique. | 
+**content** | [**SmsDefinitionContent**](SmsDefinitionContent.md) |  | 
+**status** | **String** | Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days. | [optional] 
+**createdDate** | **Date** | The date the object was created. | [optional] 
+**modifiedDate** | **Date** | The date the object was modified. | [optional] 
+**description** | **String** | User-provided description of the SMS definition. | [optional] 
+**subscriptions** | [**SmsDefinitionSubscriptions**](SmsDefinitionSubscriptions.md) |  | 
+**requestId** | **String** | The ID of the request | [optional] 
+
+
diff --git a/docs/SmsDefinitionContent.md b/docs/SmsDefinitionContent.md
@@ -0,0 +1,8 @@
+# SalesforceMarketingCloud.SmsDefinitionContent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | The message content that you want sent with each message. Use substitution strings and AMPscript to personalize the message. | 
+
+
diff --git a/docs/SmsDefinitionSubscriptions.md b/docs/SmsDefinitionSubscriptions.md
@@ -0,0 +1,11 @@
+# SalesforceMarketingCloud.SmsDefinitionSubscriptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**shortCode** | **String** | The short code for the mobile transmissions for each message on this definition. | 
+**countryCode** | **String** | The country code associated with the shortCode for the mobile transmissions for each message on this definition. | 
+**keyword** | **String** | The keyword used to track messages. | [optional] 
+**autoAddSubscriber** | **Boolean** | Permits adding a recipient as subscriber against the shortCode using contactKey. When false, the message is rejected if contactKey does not exist as a subscriber. Default is true. | [optional] [default to true]
+
+
diff --git a/docs/TransactionalMessagingApi.md b/docs/TransactionalMessagingApi.md
@@ -30,7 +30,7 @@ Method | HTTP request | Description
 
 <a name="createEmailDefinition"></a>
 # **createEmailDefinition**
-> CreateEmailDefinitionRequest createEmailDefinition(body)
+> EmailDefinition createEmailDefinition(body)
 
 createEmailDefinition
 
@@ -42,7 +42,7 @@ const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');
 
 let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();
 
-let body = new SalesforceMarketingCloud.CreateEmailDefinitionRequest(); // CreateEmailDefinitionRequest | JSON Parameters
+let body = new SalesforceMarketingCloud.EmailDefinition(); // EmailDefinition | JSON Parameters
 
 apiInstance.createEmailDefinition(body).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -56,11 +56,11 @@ apiInstance.createEmailDefinition(body).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**CreateEmailDefinitionRequest**](CreateEmailDefinitionRequest.md)| JSON Parameters | 
+ **body** | [**EmailDefinition**](EmailDefinition.md)| JSON Parameters | 
 
 ### Return type
 
-[**CreateEmailDefinitionRequest**](CreateEmailDefinitionRequest.md)
+[**EmailDefinition**](EmailDefinition.md)
 
 ### Authorization
 
@@ -73,7 +73,7 @@ No authorization required
 
 <a name="createSmsDefinition"></a>
 # **createSmsDefinition**
-> CreateSmsDefinitionRequest createSmsDefinition(body)
+> SmsDefinition createSmsDefinition(body)
 
 createSmsDefinition
 
@@ -85,7 +85,7 @@ const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');
 
 let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();
 
-let body = new SalesforceMarketingCloud.CreateSmsDefinitionRequest(); // CreateSmsDefinitionRequest | JSON Parameters
+let body = new SalesforceMarketingCloud.SmsDefinition(); // SmsDefinition | JSON Parameters
 
 apiInstance.createSmsDefinition(body).then((data) => {
   console.log('API called successfully. Returned data: ' + data);
@@ -99,11 +99,11 @@ apiInstance.createSmsDefinition(body).then((data) => {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**CreateSmsDefinitionRequest**](CreateSmsDefinitionRequest.md)| JSON Parameters | 
+ **body** | [**SmsDefinition**](SmsDefinition.md)| JSON Parameters | 
 
 ### Return type
 
-[**CreateSmsDefinitionRequest**](CreateSmsDefinitionRequest.md)
+[**SmsDefinition**](SmsDefinition.md)
 
 ### Authorization
 
@@ -288,7 +288,7 @@ No authorization required
 
 <a name="getEmailDefinition"></a>
 # **getEmailDefinition**
-> CreateEmailDefinitionRequest getEmailDefinition(definitionKey)
+> EmailDefinition getEmailDefinition(definitionKey)
 
 getEmailDefinition
 
@@ -318,7 +318,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**CreateEmailDefinitionRequest**](CreateEmailDefinitionRequest.md)
+[**EmailDefinition**](EmailDefinition.md)
 
 ### Authorization
 
@@ -608,7 +608,7 @@ No authorization required
 
 <a name="getSmsDefinition"></a>
 # **getSmsDefinition**
-> CreateSmsDefinitionRequest getSmsDefinition(definitionKey)
+> SmsDefinition getSmsDefinition(definitionKey)
 
 getSmsDefinition
 
@@ -638,7 +638,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**CreateSmsDefinitionRequest**](CreateSmsDefinitionRequest.md)
+[**SmsDefinition**](SmsDefinition.md)
 
 ### Authorization
 
@@ -744,7 +744,7 @@ No authorization required
 
 <a name="partiallyUpdateEmailDefinition"></a>
 # **partiallyUpdateEmailDefinition**
-> CreateEmailDefinitionRequest partiallyUpdateEmailDefinition(definitionKey, body)
+> EmailDefinition partiallyUpdateEmailDefinition(definitionKey, body)
 
 partiallyUpdateEmailDefinition
 
@@ -777,7 +777,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**CreateEmailDefinitionRequest**](CreateEmailDefinitionRequest.md)
+[**EmailDefinition**](EmailDefinition.md)
 
 ### Authorization
 
@@ -790,7 +790,7 @@ No authorization required
 
 <a name="partiallyUpdateSmsDefinition"></a>
 # **partiallyUpdateSmsDefinition**
-> CreateSmsDefinitionRequest partiallyUpdateSmsDefinition(definitionKey, body)
+> SmsDefinition partiallyUpdateSmsDefinition(definitionKey, body)
 
 partiallyUpdateSmsDefinition
 
@@ -823,7 +823,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**CreateSmsDefinitionRequest**](CreateSmsDefinitionRequest.md)
+[**SmsDefinition**](SmsDefinition.md)
 
 ### Authorization
 

diff --git a/docs/UpdateEmailDefinitionRequest.md b/docs/UpdateEmailDefinitionRequest.md
@@ -4,11 +4,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the definition. Must be unique. | [optional] 
-**content** | [**CreateEmailDefinitionContent**](CreateEmailDefinitionContent.md) |  | [optional] 
+**content** | [**EmailDefinitionContent**](EmailDefinitionContent.md) |  | [optional] 
 **status** | **String** | Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days. | [optional] 
 **description** | **String** | User-provided description of the email definition. | [optional] 
 **classification** | **String** | Marketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional. | [optional] 
-**subscriptions** | [**CreateEmailDefinitionSubscriptions**](CreateEmailDefinitionSubscriptions.md) |  | [optional] 
-**options** | [**CreateEmailDefinitionOptionsRequest**](CreateEmailDefinitionOptionsRequest.md) |  | [optional] 
+**subscriptions** | [**EmailDefinitionSubscriptions**](EmailDefinitionSubscriptions.md) |  | [optional] 
+**options** | [**EmailDefinitionOptions**](EmailDefinitionOptions.md) |  | [optional] 
 
 
diff --git a/docs/UpdateSmsDefinitionRequest.md b/docs/UpdateSmsDefinitionRequest.md
@@ -4,9 +4,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of the definition. Must be unique. | [optional] 
-**content** | [**CreateSmsDefinitionContent**](CreateSmsDefinitionContent.md) |  | [optional] 
+**content** | [**SmsDefinitionContent**](SmsDefinitionContent.md) |  | [optional] 
 **status** | **String** | Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn’t processed or delivered. Instead, the message is queued for later processing for up to three days. | [optional] 
 **description** | **String** | User-provided description of the SMS definition. | [optional] 
-**subscriptions** | [**CreateSmsDefinitionSubscriptions**](CreateSmsDefinitionSubscriptions.md) |  | [optional] 
+**subscriptions** | [**SmsDefinitionSubscriptions**](SmsDefinitionSubscriptions.md) |  | [optional]