diff --git a/README.md b/README.md index 487ddaa..9ef215c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # SalesforceMarketingCloud -SalesforceMarketingCloud - JavaScript client for SalesforceMarketingCloud +salesforce-marketing-cloud-sdk - JavaScript client for SalesforceMarketingCloud Marketing Cloud's REST API is our newest API. It supports multi-channel use cases, is much more lightweight and easy to use than our SOAP API, and is getting more comprehensive with every release. This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: @@ -43,7 +43,7 @@ Please follow the [installation](#installation) instruction and execute the foll #### Using the Client class with the configuration passed through environment variables ```javascript -const SalesforceMarketingCloud = require('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require('SalesforceMarketingCloud'); const Client = require('SalesforceMarketingCloud/src/Api/Client'); let client = new Client(); @@ -76,7 +76,7 @@ createAssetResult.then(data => { #### Using the Client class with the configuration passed through a configuration object ```javascript -const SalesforceMarketingCloud = require('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require('SalesforceMarketingCloud'); const Client = require('SalesforceMarketingCloud/src/Api/Client'); const config = { @@ -113,71 +113,71 @@ All URIs are relative to *https://www.exacttargetapis.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*SalesforceMarketingCloud.AssetApi* | [**createAsset**](docs/AssetApi.md#createAsset) | **POST** /asset/v1/content/assets | createAsset -*SalesforceMarketingCloud.AssetApi* | [**deleteAssetById**](docs/AssetApi.md#deleteAssetById) | **DELETE** /asset/v1/content/assets/{id} | deleteAssetById -*SalesforceMarketingCloud.AssetApi* | [**getAssetById**](docs/AssetApi.md#getAssetById) | **GET** /asset/v1/content/assets/{id} | getAssetById -*SalesforceMarketingCloud.AssetApi* | [**partiallyUpdateAssetById**](docs/AssetApi.md#partiallyUpdateAssetById) | **PATCH** /asset/v1/content/assets/{id} | partiallyUpdateAssetById -*SalesforceMarketingCloud.CampaignApi* | [**createCampaign**](docs/CampaignApi.md#createCampaign) | **POST** /hub/v1/campaigns | createCampaign -*SalesforceMarketingCloud.CampaignApi* | [**deleteCampaignById**](docs/CampaignApi.md#deleteCampaignById) | **DELETE** /hub/v1/campaigns/{id} | deleteCampaignById -*SalesforceMarketingCloud.CampaignApi* | [**getCampaignById**](docs/CampaignApi.md#getCampaignById) | **GET** /hub/v1/campaigns/{id} | getCampaignById -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**createEmailDefinition**](docs/TransactionalMessagingApi.md#createEmailDefinition) | **POST** /messaging/v1/email/definitions/ | createEmailDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**createSmsDefinition**](docs/TransactionalMessagingApi.md#createSmsDefinition) | **POST** /messaging/v1/sms/definitions | createSmsDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**deleteEmailDefinition**](docs/TransactionalMessagingApi.md#deleteEmailDefinition) | **DELETE** /messaging/v1/email/definitions/{definitionKey} | deleteEmailDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**deleteQueuedMessagesForEmailDefinition**](docs/TransactionalMessagingApi.md#deleteQueuedMessagesForEmailDefinition) | **DELETE** /messaging/v1/email/definitions/{definitionKey}/queue | deleteQueuedMessagesForEmailDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**deleteQueuedMessagesForSmsDefinition**](docs/TransactionalMessagingApi.md#deleteQueuedMessagesForSmsDefinition) | **DELETE** /messaging/v1/sms/definitions/{definitionKey}/queue | deleteQueuedMessagesForSmsDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**deleteSmsDefinition**](docs/TransactionalMessagingApi.md#deleteSmsDefinition) | **DELETE** /messaging/v1/sms/definitions/{definitionKey} | deleteSmsDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getEmailDefinition**](docs/TransactionalMessagingApi.md#getEmailDefinition) | **GET** /messaging/v1/email/definitions/{definitionKey} | getEmailDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getEmailDefinitions**](docs/TransactionalMessagingApi.md#getEmailDefinitions) | **GET** /messaging/v1/email/definitions/ | getEmailDefinitions -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getEmailSendStatusForRecipient**](docs/TransactionalMessagingApi.md#getEmailSendStatusForRecipient) | **GET** /messaging/v1/email/messages/{messageKey} | getEmailSendStatusForRecipient -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getEmailsNotSentToRecipients**](docs/TransactionalMessagingApi.md#getEmailsNotSentToRecipients) | **GET** /messaging/v1/email/messages/ | getEmailsNotSentToRecipients -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getQueueMetricsForEmailDefinition**](docs/TransactionalMessagingApi.md#getQueueMetricsForEmailDefinition) | **GET** /messaging/v1/email/definitions/{definitionKey}/queue | getQueueMetricsForEmailDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getQueueMetricsForSmsDefinition**](docs/TransactionalMessagingApi.md#getQueueMetricsForSmsDefinition) | **GET** /messaging/v1/sms/definitions/{definitionKey}/queue | getQueueMetricsForSmsDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getSMSsNotSentToRecipients**](docs/TransactionalMessagingApi.md#getSMSsNotSentToRecipients) | **GET** /messaging/v1/sms/messages/ | getSMSsNotSentToRecipients -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getSmsDefinition**](docs/TransactionalMessagingApi.md#getSmsDefinition) | **GET** /messaging/v1/sms/definitions/{definitionKey} | getSmsDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getSmsDefinitions**](docs/TransactionalMessagingApi.md#getSmsDefinitions) | **GET** /messaging/v1/sms/definitions | getSmsDefinitions -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**getSmsSendStatusForRecipient**](docs/TransactionalMessagingApi.md#getSmsSendStatusForRecipient) | **GET** /messaging/v1/sms/messages/{messageKey} | getSmsSendStatusForRecipient -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**partiallyUpdateEmailDefinition**](docs/TransactionalMessagingApi.md#partiallyUpdateEmailDefinition) | **PATCH** /messaging/v1/email/definitions/{definitionKey} | partiallyUpdateEmailDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**partiallyUpdateSmsDefinition**](docs/TransactionalMessagingApi.md#partiallyUpdateSmsDefinition) | **PATCH** /messaging/v1/sms/definitions/{definitionKey} | partiallyUpdateSmsDefinition -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**sendEmailToMultipleRecipients**](docs/TransactionalMessagingApi.md#sendEmailToMultipleRecipients) | **POST** /messaging/v1/email/messages/ | sendEmailToMultipleRecipients -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**sendEmailToSingleRecipient**](docs/TransactionalMessagingApi.md#sendEmailToSingleRecipient) | **POST** /messaging/v1/email/messages/{messageKey} | sendEmailToSingleRecipient -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**sendSmsToMultipleRecipients**](docs/TransactionalMessagingApi.md#sendSmsToMultipleRecipients) | **POST** /messaging/v1/sms/messages/ | sendSmsToMultipleRecipients -*SalesforceMarketingCloud.TransactionalMessagingApi* | [**sendSmsToSingleRecipient**](docs/TransactionalMessagingApi.md#sendSmsToSingleRecipient) | **POST** /messaging/v1/sms/messages/{messageKey} | sendSmsToSingleRecipient +*salesforce-marketing-cloud-sdk.AssetApi* | [**createAsset**](docs/AssetApi.md#createAsset) | **POST** /asset/v1/content/assets | createAsset +*salesforce-marketing-cloud-sdk.AssetApi* | [**deleteAssetById**](docs/AssetApi.md#deleteAssetById) | **DELETE** /asset/v1/content/assets/{id} | deleteAssetById +*salesforce-marketing-cloud-sdk.AssetApi* | [**getAssetById**](docs/AssetApi.md#getAssetById) | **GET** /asset/v1/content/assets/{id} | getAssetById +*salesforce-marketing-cloud-sdk.AssetApi* | [**partiallyUpdateAssetById**](docs/AssetApi.md#partiallyUpdateAssetById) | **PATCH** /asset/v1/content/assets/{id} | partiallyUpdateAssetById +*salesforce-marketing-cloud-sdk.CampaignApi* | [**createCampaign**](docs/CampaignApi.md#createCampaign) | **POST** /hub/v1/campaigns | createCampaign +*salesforce-marketing-cloud-sdk.CampaignApi* | [**deleteCampaignById**](docs/CampaignApi.md#deleteCampaignById) | **DELETE** /hub/v1/campaigns/{id} | deleteCampaignById +*salesforce-marketing-cloud-sdk.CampaignApi* | [**getCampaignById**](docs/CampaignApi.md#getCampaignById) | **GET** /hub/v1/campaigns/{id} | getCampaignById +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**createEmailDefinition**](docs/TransactionalMessagingApi.md#createEmailDefinition) | **POST** /messaging/v1/email/definitions/ | createEmailDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**createSmsDefinition**](docs/TransactionalMessagingApi.md#createSmsDefinition) | **POST** /messaging/v1/sms/definitions | createSmsDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**deleteEmailDefinition**](docs/TransactionalMessagingApi.md#deleteEmailDefinition) | **DELETE** /messaging/v1/email/definitions/{definitionKey} | deleteEmailDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**deleteQueuedMessagesForEmailDefinition**](docs/TransactionalMessagingApi.md#deleteQueuedMessagesForEmailDefinition) | **DELETE** /messaging/v1/email/definitions/{definitionKey}/queue | deleteQueuedMessagesForEmailDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**deleteQueuedMessagesForSmsDefinition**](docs/TransactionalMessagingApi.md#deleteQueuedMessagesForSmsDefinition) | **DELETE** /messaging/v1/sms/definitions/{definitionKey}/queue | deleteQueuedMessagesForSmsDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**deleteSmsDefinition**](docs/TransactionalMessagingApi.md#deleteSmsDefinition) | **DELETE** /messaging/v1/sms/definitions/{definitionKey} | deleteSmsDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getEmailDefinition**](docs/TransactionalMessagingApi.md#getEmailDefinition) | **GET** /messaging/v1/email/definitions/{definitionKey} | getEmailDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getEmailDefinitions**](docs/TransactionalMessagingApi.md#getEmailDefinitions) | **GET** /messaging/v1/email/definitions/ | getEmailDefinitions +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getEmailSendStatusForRecipient**](docs/TransactionalMessagingApi.md#getEmailSendStatusForRecipient) | **GET** /messaging/v1/email/messages/{messageKey} | getEmailSendStatusForRecipient +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getEmailsNotSentToRecipients**](docs/TransactionalMessagingApi.md#getEmailsNotSentToRecipients) | **GET** /messaging/v1/email/messages/ | getEmailsNotSentToRecipients +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getQueueMetricsForEmailDefinition**](docs/TransactionalMessagingApi.md#getQueueMetricsForEmailDefinition) | **GET** /messaging/v1/email/definitions/{definitionKey}/queue | getQueueMetricsForEmailDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getQueueMetricsForSmsDefinition**](docs/TransactionalMessagingApi.md#getQueueMetricsForSmsDefinition) | **GET** /messaging/v1/sms/definitions/{definitionKey}/queue | getQueueMetricsForSmsDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getSMSsNotSentToRecipients**](docs/TransactionalMessagingApi.md#getSMSsNotSentToRecipients) | **GET** /messaging/v1/sms/messages/ | getSMSsNotSentToRecipients +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getSmsDefinition**](docs/TransactionalMessagingApi.md#getSmsDefinition) | **GET** /messaging/v1/sms/definitions/{definitionKey} | getSmsDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getSmsDefinitions**](docs/TransactionalMessagingApi.md#getSmsDefinitions) | **GET** /messaging/v1/sms/definitions | getSmsDefinitions +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**getSmsSendStatusForRecipient**](docs/TransactionalMessagingApi.md#getSmsSendStatusForRecipient) | **GET** /messaging/v1/sms/messages/{messageKey} | getSmsSendStatusForRecipient +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**partiallyUpdateEmailDefinition**](docs/TransactionalMessagingApi.md#partiallyUpdateEmailDefinition) | **PATCH** /messaging/v1/email/definitions/{definitionKey} | partiallyUpdateEmailDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**partiallyUpdateSmsDefinition**](docs/TransactionalMessagingApi.md#partiallyUpdateSmsDefinition) | **PATCH** /messaging/v1/sms/definitions/{definitionKey} | partiallyUpdateSmsDefinition +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**sendEmailToMultipleRecipients**](docs/TransactionalMessagingApi.md#sendEmailToMultipleRecipients) | **POST** /messaging/v1/email/messages/ | sendEmailToMultipleRecipients +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**sendEmailToSingleRecipient**](docs/TransactionalMessagingApi.md#sendEmailToSingleRecipient) | **POST** /messaging/v1/email/messages/{messageKey} | sendEmailToSingleRecipient +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**sendSmsToMultipleRecipients**](docs/TransactionalMessagingApi.md#sendSmsToMultipleRecipients) | **POST** /messaging/v1/sms/messages/ | sendSmsToMultipleRecipients +*salesforce-marketing-cloud-sdk.TransactionalMessagingApi* | [**sendSmsToSingleRecipient**](docs/TransactionalMessagingApi.md#sendSmsToSingleRecipient) | **POST** /messaging/v1/sms/messages/{messageKey} | sendSmsToSingleRecipient ## Documentation for Models - - [SalesforceMarketingCloud.ApiError](docs/ApiError.md) - - [SalesforceMarketingCloud.Asset](docs/Asset.md) - - [SalesforceMarketingCloud.AssetType](docs/AssetType.md) - - [SalesforceMarketingCloud.Attributes](docs/Attributes.md) - - [SalesforceMarketingCloud.Campaign](docs/Campaign.md) - - [SalesforceMarketingCloud.CreateEmailDefinitionContent](docs/CreateEmailDefinitionContent.md) - - [SalesforceMarketingCloud.CreateEmailDefinitionOptionsRequest](docs/CreateEmailDefinitionOptionsRequest.md) - - [SalesforceMarketingCloud.CreateEmailDefinitionRequest](docs/CreateEmailDefinitionRequest.md) - - [SalesforceMarketingCloud.CreateEmailDefinitionSubscriptions](docs/CreateEmailDefinitionSubscriptions.md) - - [SalesforceMarketingCloud.CreateSmsDefinitionContent](docs/CreateSmsDefinitionContent.md) - - [SalesforceMarketingCloud.CreateSmsDefinitionRequest](docs/CreateSmsDefinitionRequest.md) - - [SalesforceMarketingCloud.CreateSmsDefinitionSubscriptions](docs/CreateSmsDefinitionSubscriptions.md) - - [SalesforceMarketingCloud.DeleteQueuedMessagesForSendDefinitionResponse](docs/DeleteQueuedMessagesForSendDefinitionResponse.md) - - [SalesforceMarketingCloud.DeleteSendDefinitionResponse](docs/DeleteSendDefinitionResponse.md) - - [SalesforceMarketingCloud.GetDefinitionSendStatusForRecipientResponse](docs/GetDefinitionSendStatusForRecipientResponse.md) - - [SalesforceMarketingCloud.GetDefinitionSendStatusForRecipientResponseInfo](docs/GetDefinitionSendStatusForRecipientResponseInfo.md) - - [SalesforceMarketingCloud.GetDefinitionsNotSentToRecipientsMessage](docs/GetDefinitionsNotSentToRecipientsMessage.md) - - [SalesforceMarketingCloud.GetDefinitionsNotSentToRecipientsMessageInfo](docs/GetDefinitionsNotSentToRecipientsMessageInfo.md) - - [SalesforceMarketingCloud.GetDefinitionsNotSentToRecipientsResponse](docs/GetDefinitionsNotSentToRecipientsResponse.md) - - [SalesforceMarketingCloud.GetEmailDefinitionsResponse](docs/GetEmailDefinitionsResponse.md) - - [SalesforceMarketingCloud.GetQueueMetricsForSendDefinitionResponse](docs/GetQueueMetricsForSendDefinitionResponse.md) - - [SalesforceMarketingCloud.GetSmsDefinitionsResponse](docs/GetSmsDefinitionsResponse.md) - - [SalesforceMarketingCloud.Recipient](docs/Recipient.md) - - [SalesforceMarketingCloud.SendDefinitionResponseItem](docs/SendDefinitionResponseItem.md) - - [SalesforceMarketingCloud.SendDefinitionToMultipleRecipientsResponse](docs/SendDefinitionToMultipleRecipientsResponse.md) - - [SalesforceMarketingCloud.SendDefinitionToSingleRecipientResponse](docs/SendDefinitionToSingleRecipientResponse.md) - - [SalesforceMarketingCloud.SendEmailToMultipleRecipientsRequest](docs/SendEmailToMultipleRecipientsRequest.md) - - [SalesforceMarketingCloud.SendEmailToSingleRecipientRequest](docs/SendEmailToSingleRecipientRequest.md) - - [SalesforceMarketingCloud.SendSmsContentRequest](docs/SendSmsContentRequest.md) - - [SalesforceMarketingCloud.SendSmsToMultipleRecipientsRequest](docs/SendSmsToMultipleRecipientsRequest.md) - - [SalesforceMarketingCloud.SendSmsToMultipleRecipientsSubscriptionsRequest](docs/SendSmsToMultipleRecipientsSubscriptionsRequest.md) - - [SalesforceMarketingCloud.SendSmsToSingleRecipientRequest](docs/SendSmsToSingleRecipientRequest.md) - - [SalesforceMarketingCloud.SharingProperties](docs/SharingProperties.md) - - [SalesforceMarketingCloud.UpdateEmailDefinitionRequest](docs/UpdateEmailDefinitionRequest.md) - - [SalesforceMarketingCloud.UpdateSmsDefinitionRequest](docs/UpdateSmsDefinitionRequest.md) + - [salesforce-marketing-cloud-sdk.ApiError](docs/ApiError.md) + - [salesforce-marketing-cloud-sdk.Asset](docs/Asset.md) + - [salesforce-marketing-cloud-sdk.AssetType](docs/AssetType.md) + - [salesforce-marketing-cloud-sdk.Attributes](docs/Attributes.md) + - [salesforce-marketing-cloud-sdk.Campaign](docs/Campaign.md) + - [salesforce-marketing-cloud-sdk.CreateEmailDefinitionContent](docs/CreateEmailDefinitionContent.md) + - [salesforce-marketing-cloud-sdk.CreateEmailDefinitionOptionsRequest](docs/CreateEmailDefinitionOptionsRequest.md) + - [salesforce-marketing-cloud-sdk.CreateEmailDefinitionRequest](docs/CreateEmailDefinitionRequest.md) + - [salesforce-marketing-cloud-sdk.CreateEmailDefinitionSubscriptions](docs/CreateEmailDefinitionSubscriptions.md) + - [salesforce-marketing-cloud-sdk.CreateSmsDefinitionContent](docs/CreateSmsDefinitionContent.md) + - [salesforce-marketing-cloud-sdk.CreateSmsDefinitionRequest](docs/CreateSmsDefinitionRequest.md) + - [salesforce-marketing-cloud-sdk.CreateSmsDefinitionSubscriptions](docs/CreateSmsDefinitionSubscriptions.md) + - [salesforce-marketing-cloud-sdk.DeleteQueuedMessagesForSendDefinitionResponse](docs/DeleteQueuedMessagesForSendDefinitionResponse.md) + - [salesforce-marketing-cloud-sdk.DeleteSendDefinitionResponse](docs/DeleteSendDefinitionResponse.md) + - [salesforce-marketing-cloud-sdk.GetDefinitionSendStatusForRecipientResponse](docs/GetDefinitionSendStatusForRecipientResponse.md) + - [salesforce-marketing-cloud-sdk.GetDefinitionSendStatusForRecipientResponseInfo](docs/GetDefinitionSendStatusForRecipientResponseInfo.md) + - [salesforce-marketing-cloud-sdk.GetDefinitionsNotSentToRecipientsMessage](docs/GetDefinitionsNotSentToRecipientsMessage.md) + - [salesforce-marketing-cloud-sdk.GetDefinitionsNotSentToRecipientsMessageInfo](docs/GetDefinitionsNotSentToRecipientsMessageInfo.md) + - [salesforce-marketing-cloud-sdk.GetDefinitionsNotSentToRecipientsResponse](docs/GetDefinitionsNotSentToRecipientsResponse.md) + - [salesforce-marketing-cloud-sdk.GetEmailDefinitionsResponse](docs/GetEmailDefinitionsResponse.md) + - [salesforce-marketing-cloud-sdk.GetQueueMetricsForSendDefinitionResponse](docs/GetQueueMetricsForSendDefinitionResponse.md) + - [salesforce-marketing-cloud-sdk.GetSmsDefinitionsResponse](docs/GetSmsDefinitionsResponse.md) + - [salesforce-marketing-cloud-sdk.Recipient](docs/Recipient.md) + - [salesforce-marketing-cloud-sdk.SendDefinitionResponseItem](docs/SendDefinitionResponseItem.md) + - [salesforce-marketing-cloud-sdk.SendDefinitionToMultipleRecipientsResponse](docs/SendDefinitionToMultipleRecipientsResponse.md) + - [salesforce-marketing-cloud-sdk.SendDefinitionToSingleRecipientResponse](docs/SendDefinitionToSingleRecipientResponse.md) + - [salesforce-marketing-cloud-sdk.SendEmailToMultipleRecipientsRequest](docs/SendEmailToMultipleRecipientsRequest.md) + - [salesforce-marketing-cloud-sdk.SendEmailToSingleRecipientRequest](docs/SendEmailToSingleRecipientRequest.md) + - [salesforce-marketing-cloud-sdk.SendSmsContentRequest](docs/SendSmsContentRequest.md) + - [salesforce-marketing-cloud-sdk.SendSmsToMultipleRecipientsRequest](docs/SendSmsToMultipleRecipientsRequest.md) + - [salesforce-marketing-cloud-sdk.SendSmsToMultipleRecipientsSubscriptionsRequest](docs/SendSmsToMultipleRecipientsSubscriptionsRequest.md) + - [salesforce-marketing-cloud-sdk.SendSmsToSingleRecipientRequest](docs/SendSmsToSingleRecipientRequest.md) + - [salesforce-marketing-cloud-sdk.SharingProperties](docs/SharingProperties.md) + - [salesforce-marketing-cloud-sdk.UpdateEmailDefinitionRequest](docs/UpdateEmailDefinitionRequest.md) + - [salesforce-marketing-cloud-sdk.UpdateSmsDefinitionRequest](docs/UpdateSmsDefinitionRequest.md) diff --git a/docs/ApiError.md b/docs/ApiError.md index 78b7010..b2df7b0 100644 --- a/docs/ApiError.md +++ b/docs/ApiError.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.ApiError +# salesforce-marketing-cloud-sdk.ApiError ## Properties Name | Type | Description | Notes diff --git a/docs/Asset.md b/docs/Asset.md index 5e735c4..d4ba02d 100644 --- a/docs/Asset.md +++ b/docs/Asset.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.Asset +# salesforce-marketing-cloud-sdk.Asset ## Properties Name | Type | Description | Notes diff --git a/docs/AssetApi.md b/docs/AssetApi.md index 112d29c..737f60a 100644 --- a/docs/AssetApi.md +++ b/docs/AssetApi.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.AssetApi +# salesforce-marketing-cloud-sdk.AssetApi All URIs are relative to *https://www.exacttargetapis.com* @@ -20,11 +20,11 @@ Creates a new asset. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.AssetApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.AssetApi(); -let body = new SalesforceMarketingCloud.Asset(); // Asset | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.Asset(); // Asset | JSON Parameters apiInstance.createAsset(body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -63,9 +63,9 @@ Deletes an asset. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.AssetApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.AssetApi(); let id = 8.14; // Number | The ID of the asset to delete @@ -106,9 +106,9 @@ Gets an asset by ID. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.AssetApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.AssetApi(); let id = 8.14; // Number | The ID of the asset @@ -149,13 +149,13 @@ Updates part of an asset. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.AssetApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.AssetApi(); let id = 8.14; // Number | The ID of the asset to update -let body = new SalesforceMarketingCloud.Asset(); // Asset | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.Asset(); // Asset | JSON Parameters apiInstance.partiallyUpdateAssetById(id, body).then((data) => { console.log('API called successfully. Returned data: ' + data); diff --git a/docs/AssetType.md b/docs/AssetType.md index c3da54e..d4cd7ee 100644 --- a/docs/AssetType.md +++ b/docs/AssetType.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.AssetType +# salesforce-marketing-cloud-sdk.AssetType ## Properties Name | Type | Description | Notes diff --git a/docs/Attributes.md b/docs/Attributes.md index 5044465..6b829dc 100644 --- a/docs/Attributes.md +++ b/docs/Attributes.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.Attributes +# salesforce-marketing-cloud-sdk.Attributes ## Properties Name | Type | Description | Notes diff --git a/docs/Campaign.md b/docs/Campaign.md index 91325b5..03d4eb4 100644 --- a/docs/Campaign.md +++ b/docs/Campaign.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.Campaign +# salesforce-marketing-cloud-sdk.Campaign ## Properties Name | Type | Description | Notes diff --git a/docs/CampaignApi.md b/docs/CampaignApi.md index 74746b0..1ae710a 100644 --- a/docs/CampaignApi.md +++ b/docs/CampaignApi.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.CampaignApi +# salesforce-marketing-cloud-sdk.CampaignApi All URIs are relative to *https://www.exacttargetapis.com* @@ -19,11 +19,11 @@ Creates a campaign. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.CampaignApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.CampaignApi(); -let body = new SalesforceMarketingCloud.Campaign(); // Campaign | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.Campaign(); // Campaign | JSON Parameters apiInstance.createCampaign(body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -62,9 +62,9 @@ Deletes a campaign. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.CampaignApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.CampaignApi(); let id = "id_example"; // String | The ID of the campaign to delete @@ -105,9 +105,9 @@ Retrieves a campaign. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.CampaignApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.CampaignApi(); let id = "id_example"; // String | Campaign ID diff --git a/docs/CreateEmailDefinitionContent.md b/docs/CreateEmailDefinitionContent.md index 94d4220..c083a79 100644 --- a/docs/CreateEmailDefinitionContent.md +++ b/docs/CreateEmailDefinitionContent.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.CreateEmailDefinitionContent +# salesforce-marketing-cloud-sdk.CreateEmailDefinitionContent ## Properties Name | Type | Description | Notes diff --git a/docs/CreateEmailDefinitionOptionsRequest.md b/docs/CreateEmailDefinitionOptionsRequest.md index 987bc9f..06d457f 100644 --- a/docs/CreateEmailDefinitionOptionsRequest.md +++ b/docs/CreateEmailDefinitionOptionsRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.CreateEmailDefinitionOptionsRequest +# salesforce-marketing-cloud-sdk.CreateEmailDefinitionOptionsRequest ## Properties Name | Type | Description | Notes diff --git a/docs/CreateEmailDefinitionRequest.md b/docs/CreateEmailDefinitionRequest.md index b3031c5..854e380 100644 --- a/docs/CreateEmailDefinitionRequest.md +++ b/docs/CreateEmailDefinitionRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.CreateEmailDefinitionRequest +# salesforce-marketing-cloud-sdk.CreateEmailDefinitionRequest ## Properties Name | Type | Description | Notes diff --git a/docs/CreateEmailDefinitionSubscriptions.md b/docs/CreateEmailDefinitionSubscriptions.md index 470232a..ff245bc 100644 --- a/docs/CreateEmailDefinitionSubscriptions.md +++ b/docs/CreateEmailDefinitionSubscriptions.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.CreateEmailDefinitionSubscriptions +# salesforce-marketing-cloud-sdk.CreateEmailDefinitionSubscriptions ## Properties Name | Type | Description | Notes diff --git a/docs/CreateSmsDefinitionContent.md b/docs/CreateSmsDefinitionContent.md index 2714b4a..140636f 100644 --- a/docs/CreateSmsDefinitionContent.md +++ b/docs/CreateSmsDefinitionContent.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.CreateSmsDefinitionContent +# salesforce-marketing-cloud-sdk.CreateSmsDefinitionContent ## Properties Name | Type | Description | Notes diff --git a/docs/CreateSmsDefinitionRequest.md b/docs/CreateSmsDefinitionRequest.md index 671a334..89a48c8 100644 --- a/docs/CreateSmsDefinitionRequest.md +++ b/docs/CreateSmsDefinitionRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.CreateSmsDefinitionRequest +# salesforce-marketing-cloud-sdk.CreateSmsDefinitionRequest ## Properties Name | Type | Description | Notes diff --git a/docs/CreateSmsDefinitionSubscriptions.md b/docs/CreateSmsDefinitionSubscriptions.md index d509d2b..ea58930 100644 --- a/docs/CreateSmsDefinitionSubscriptions.md +++ b/docs/CreateSmsDefinitionSubscriptions.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.CreateSmsDefinitionSubscriptions +# salesforce-marketing-cloud-sdk.CreateSmsDefinitionSubscriptions ## Properties Name | Type | Description | Notes diff --git a/docs/DeleteQueuedMessagesForSendDefinitionResponse.md b/docs/DeleteQueuedMessagesForSendDefinitionResponse.md index e09140d..efd6eca 100644 --- a/docs/DeleteQueuedMessagesForSendDefinitionResponse.md +++ b/docs/DeleteQueuedMessagesForSendDefinitionResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.DeleteQueuedMessagesForSendDefinitionResponse +# salesforce-marketing-cloud-sdk.DeleteQueuedMessagesForSendDefinitionResponse ## Properties Name | Type | Description | Notes diff --git a/docs/DeleteSendDefinitionResponse.md b/docs/DeleteSendDefinitionResponse.md index 1f006d8..597023e 100644 --- a/docs/DeleteSendDefinitionResponse.md +++ b/docs/DeleteSendDefinitionResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.DeleteSendDefinitionResponse +# salesforce-marketing-cloud-sdk.DeleteSendDefinitionResponse ## Properties Name | Type | Description | Notes diff --git a/docs/GetDefinitionSendStatusForRecipientResponse.md b/docs/GetDefinitionSendStatusForRecipientResponse.md index 130ef11..4890080 100644 --- a/docs/GetDefinitionSendStatusForRecipientResponse.md +++ b/docs/GetDefinitionSendStatusForRecipientResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.GetDefinitionSendStatusForRecipientResponse +# salesforce-marketing-cloud-sdk.GetDefinitionSendStatusForRecipientResponse ## Properties Name | Type | Description | Notes diff --git a/docs/GetDefinitionSendStatusForRecipientResponseInfo.md b/docs/GetDefinitionSendStatusForRecipientResponseInfo.md index 6d2d2b4..356c13b 100644 --- a/docs/GetDefinitionSendStatusForRecipientResponseInfo.md +++ b/docs/GetDefinitionSendStatusForRecipientResponseInfo.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.GetDefinitionSendStatusForRecipientResponseInfo +# salesforce-marketing-cloud-sdk.GetDefinitionSendStatusForRecipientResponseInfo ## Properties Name | Type | Description | Notes diff --git a/docs/GetDefinitionsNotSentToRecipientsMessage.md b/docs/GetDefinitionsNotSentToRecipientsMessage.md index c4ea52c..707bfb3 100644 --- a/docs/GetDefinitionsNotSentToRecipientsMessage.md +++ b/docs/GetDefinitionsNotSentToRecipientsMessage.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.GetDefinitionsNotSentToRecipientsMessage +# salesforce-marketing-cloud-sdk.GetDefinitionsNotSentToRecipientsMessage ## Properties Name | Type | Description | Notes diff --git a/docs/GetDefinitionsNotSentToRecipientsMessageInfo.md b/docs/GetDefinitionsNotSentToRecipientsMessageInfo.md index c578a94..ad12f80 100644 --- a/docs/GetDefinitionsNotSentToRecipientsMessageInfo.md +++ b/docs/GetDefinitionsNotSentToRecipientsMessageInfo.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.GetDefinitionsNotSentToRecipientsMessageInfo +# salesforce-marketing-cloud-sdk.GetDefinitionsNotSentToRecipientsMessageInfo ## Properties Name | Type | Description | Notes diff --git a/docs/GetDefinitionsNotSentToRecipientsResponse.md b/docs/GetDefinitionsNotSentToRecipientsResponse.md index f91850c..eecc7cb 100644 --- a/docs/GetDefinitionsNotSentToRecipientsResponse.md +++ b/docs/GetDefinitionsNotSentToRecipientsResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.GetDefinitionsNotSentToRecipientsResponse +# salesforce-marketing-cloud-sdk.GetDefinitionsNotSentToRecipientsResponse ## Properties Name | Type | Description | Notes diff --git a/docs/GetEmailDefinitionsResponse.md b/docs/GetEmailDefinitionsResponse.md index b6616e3..aecc2a7 100644 --- a/docs/GetEmailDefinitionsResponse.md +++ b/docs/GetEmailDefinitionsResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.GetEmailDefinitionsResponse +# salesforce-marketing-cloud-sdk.GetEmailDefinitionsResponse ## Properties Name | Type | Description | Notes diff --git a/docs/GetQueueMetricsForSendDefinitionResponse.md b/docs/GetQueueMetricsForSendDefinitionResponse.md index 0b5dd97..b47edcb 100644 --- a/docs/GetQueueMetricsForSendDefinitionResponse.md +++ b/docs/GetQueueMetricsForSendDefinitionResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.GetQueueMetricsForSendDefinitionResponse +# salesforce-marketing-cloud-sdk.GetQueueMetricsForSendDefinitionResponse ## Properties Name | Type | Description | Notes diff --git a/docs/GetSmsDefinitionsResponse.md b/docs/GetSmsDefinitionsResponse.md index 721dbe7..ecb178d 100644 --- a/docs/GetSmsDefinitionsResponse.md +++ b/docs/GetSmsDefinitionsResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.GetSmsDefinitionsResponse +# salesforce-marketing-cloud-sdk.GetSmsDefinitionsResponse ## Properties Name | Type | Description | Notes diff --git a/docs/Recipient.md b/docs/Recipient.md index 6b6e3b3..6f4dd64 100644 --- a/docs/Recipient.md +++ b/docs/Recipient.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.Recipient +# salesforce-marketing-cloud-sdk.Recipient ## Properties Name | Type | Description | Notes diff --git a/docs/SendDefinitionResponseItem.md b/docs/SendDefinitionResponseItem.md index 3bdfa9a..1bbb032 100644 --- a/docs/SendDefinitionResponseItem.md +++ b/docs/SendDefinitionResponseItem.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendDefinitionResponseItem +# salesforce-marketing-cloud-sdk.SendDefinitionResponseItem ## Properties Name | Type | Description | Notes diff --git a/docs/SendDefinitionToMultipleRecipientsResponse.md b/docs/SendDefinitionToMultipleRecipientsResponse.md index 1548148..2ddae94 100644 --- a/docs/SendDefinitionToMultipleRecipientsResponse.md +++ b/docs/SendDefinitionToMultipleRecipientsResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendDefinitionToMultipleRecipientsResponse +# salesforce-marketing-cloud-sdk.SendDefinitionToMultipleRecipientsResponse ## Properties Name | Type | Description | Notes diff --git a/docs/SendDefinitionToSingleRecipientResponse.md b/docs/SendDefinitionToSingleRecipientResponse.md index 2a08ac8..7a435f4 100644 --- a/docs/SendDefinitionToSingleRecipientResponse.md +++ b/docs/SendDefinitionToSingleRecipientResponse.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendDefinitionToSingleRecipientResponse +# salesforce-marketing-cloud-sdk.SendDefinitionToSingleRecipientResponse ## Properties Name | Type | Description | Notes diff --git a/docs/SendEmailToMultipleRecipientsRequest.md b/docs/SendEmailToMultipleRecipientsRequest.md index 4387552..9dd1f39 100644 --- a/docs/SendEmailToMultipleRecipientsRequest.md +++ b/docs/SendEmailToMultipleRecipientsRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendEmailToMultipleRecipientsRequest +# salesforce-marketing-cloud-sdk.SendEmailToMultipleRecipientsRequest ## Properties Name | Type | Description | Notes diff --git a/docs/SendEmailToSingleRecipientRequest.md b/docs/SendEmailToSingleRecipientRequest.md index 41c52aa..c727e93 100644 --- a/docs/SendEmailToSingleRecipientRequest.md +++ b/docs/SendEmailToSingleRecipientRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendEmailToSingleRecipientRequest +# salesforce-marketing-cloud-sdk.SendEmailToSingleRecipientRequest ## Properties Name | Type | Description | Notes diff --git a/docs/SendSmsContentRequest.md b/docs/SendSmsContentRequest.md index fa1b361..b1513d0 100644 --- a/docs/SendSmsContentRequest.md +++ b/docs/SendSmsContentRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendSmsContentRequest +# salesforce-marketing-cloud-sdk.SendSmsContentRequest ## Properties Name | Type | Description | Notes diff --git a/docs/SendSmsToMultipleRecipientsRequest.md b/docs/SendSmsToMultipleRecipientsRequest.md index 9b95661..d712e93 100644 --- a/docs/SendSmsToMultipleRecipientsRequest.md +++ b/docs/SendSmsToMultipleRecipientsRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendSmsToMultipleRecipientsRequest +# salesforce-marketing-cloud-sdk.SendSmsToMultipleRecipientsRequest ## Properties Name | Type | Description | Notes diff --git a/docs/SendSmsToMultipleRecipientsSubscriptionsRequest.md b/docs/SendSmsToMultipleRecipientsSubscriptionsRequest.md index 17b3c58..8ffe19a 100644 --- a/docs/SendSmsToMultipleRecipientsSubscriptionsRequest.md +++ b/docs/SendSmsToMultipleRecipientsSubscriptionsRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendSmsToMultipleRecipientsSubscriptionsRequest +# salesforce-marketing-cloud-sdk.SendSmsToMultipleRecipientsSubscriptionsRequest ## Properties Name | Type | Description | Notes diff --git a/docs/SendSmsToSingleRecipientRequest.md b/docs/SendSmsToSingleRecipientRequest.md index 74e31a8..3182bef 100644 --- a/docs/SendSmsToSingleRecipientRequest.md +++ b/docs/SendSmsToSingleRecipientRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SendSmsToSingleRecipientRequest +# salesforce-marketing-cloud-sdk.SendSmsToSingleRecipientRequest ## Properties Name | Type | Description | Notes diff --git a/docs/SharingProperties.md b/docs/SharingProperties.md index 584173f..30a7846 100644 --- a/docs/SharingProperties.md +++ b/docs/SharingProperties.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.SharingProperties +# salesforce-marketing-cloud-sdk.SharingProperties ## Properties Name | Type | Description | Notes diff --git a/docs/TransactionalMessagingApi.md b/docs/TransactionalMessagingApi.md index ffef7a9..5683562 100644 --- a/docs/TransactionalMessagingApi.md +++ b/docs/TransactionalMessagingApi.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.TransactionalMessagingApi +# salesforce-marketing-cloud-sdk.TransactionalMessagingApi All URIs are relative to *https://www.exacttargetapis.com* @@ -38,11 +38,11 @@ Creates the definition for an email. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); -let body = new SalesforceMarketingCloud.CreateEmailDefinitionRequest(); // CreateEmailDefinitionRequest | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.CreateEmailDefinitionRequest(); // CreateEmailDefinitionRequest | JSON Parameters apiInstance.createEmailDefinition(body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -81,11 +81,11 @@ Creates the definition for an SMS. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); -let body = new SalesforceMarketingCloud.CreateSmsDefinitionRequest(); // CreateSmsDefinitionRequest | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.CreateSmsDefinitionRequest(); // CreateSmsDefinitionRequest | JSON Parameters apiInstance.createSmsDefinition(body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -124,9 +124,9 @@ Deletes an email definition. You can't restore a deleted definition. The del ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the definition to delete @@ -167,9 +167,9 @@ Deletes the queue for an email definition. The email definition must be in inact ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the email definition @@ -210,9 +210,9 @@ Deletes the queue for a SMS definition. The SMS definition must be in inactive s ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the SMS definition @@ -253,9 +253,9 @@ Deletes an sms definition. You can't restore a deleted definition. The delet ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the definition to delete @@ -296,9 +296,9 @@ Gets email definition configuration details for a definition key. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the definition to get @@ -339,9 +339,9 @@ Gets a list of email definitions. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let opts = { 'status': "status_example", // String | Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. @@ -389,9 +389,9 @@ Gets the send status for a message. Because this route is rate-limited, use it f ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let messageKey = "messageKey_example"; // String | Unique identifier to track message send status. You must provide it in singleton requests using the recipient attribute. To provide it in batch requests, use the recipients array attribute. If you don’t provide the message key for recipients, it’s generated in the response. @@ -432,9 +432,9 @@ Gets a paginated list of messages that were not sent, ordered from oldest to new ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let type = "type_example"; // String | Only notSent is supported. @@ -481,9 +481,9 @@ Gets metrics for the messages of an email definition. Applies to messages that a ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the email definition @@ -524,9 +524,9 @@ Gets metrics for the messages of a SMS definition. Applies to messages that are ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the SMS definition @@ -567,9 +567,9 @@ Gets a paginated list of messages that were not sent, ordered from oldest to new ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let type = "type_example"; // String | Only notSent is supported. @@ -616,9 +616,9 @@ Gets SMS definition configuration details for a definition key. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the definition to get @@ -659,9 +659,9 @@ Gets a list of SMS definitions. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let opts = { 'status': "status_example", // String | Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. @@ -709,9 +709,9 @@ Gets the send status for a message. Because this route is rate-limited, use it f ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let messageKey = "messageKey_example"; // String | Unique identifier to track message send status. You must provide it in singleton requests using the recipient attribute. To provide message key in batch requests, use the recipients array attribute. If you don’t provide the message key for recipients, it’s generated in the response. @@ -752,13 +752,13 @@ Updates a specific email definition. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the definition. -let body = new SalesforceMarketingCloud.UpdateEmailDefinitionRequest(); // UpdateEmailDefinitionRequest | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.UpdateEmailDefinitionRequest(); // UpdateEmailDefinitionRequest | JSON Parameters apiInstance.partiallyUpdateEmailDefinition(definitionKey, body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -798,13 +798,13 @@ Updates a specific SMS definition. ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let definitionKey = "definitionKey_example"; // String | Unique identifier of the definition. -let body = new SalesforceMarketingCloud.UpdateSmsDefinitionRequest(); // UpdateSmsDefinitionRequest | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.UpdateSmsDefinitionRequest(); // UpdateSmsDefinitionRequest | JSON Parameters apiInstance.partiallyUpdateSmsDefinition(definitionKey, body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -844,11 +844,11 @@ Sends a message to multiple recipients using an email definition. You can provid ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); -let body = new SalesforceMarketingCloud.SendEmailToMultipleRecipientsRequest(); // SendEmailToMultipleRecipientsRequest | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.SendEmailToMultipleRecipientsRequest(); // SendEmailToMultipleRecipientsRequest | JSON Parameters apiInstance.sendEmailToMultipleRecipients(body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -887,13 +887,13 @@ Sends a message to a single recipient via an email definition using a messageKey ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let messageKey = "messageKey_example"; // String | Unique identifier used to track message status. Can be automatically created when you create a message or provided as part of the request. Each recipient in a request must have a unique messageKey. If you use a duplicate messageKey in the same send request, the message is rejected. -let body = new SalesforceMarketingCloud.SendEmailToSingleRecipientRequest(); // SendEmailToSingleRecipientRequest | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.SendEmailToSingleRecipientRequest(); // SendEmailToSingleRecipientRequest | JSON Parameters apiInstance.sendEmailToSingleRecipient(messageKey, body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -933,11 +933,11 @@ Sends a message to multiple recipients using an email definition. You can provid ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); -let body = new SalesforceMarketingCloud.SendSmsToMultipleRecipientsRequest(); // SendSmsToMultipleRecipientsRequest | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.SendSmsToMultipleRecipientsRequest(); // SendSmsToMultipleRecipientsRequest | JSON Parameters apiInstance.sendSmsToMultipleRecipients(body).then((data) => { console.log('API called successfully. Returned data: ' + data); @@ -976,13 +976,13 @@ Sends a message to a single recipient via a SMS definition using a messageKey pa ### Example ```javascript -const SalesforceMarketingCloud = require ('SalesforceMarketingCloud'); +const salesforce-marketing-cloud-sdk = require ('SalesforceMarketingCloud'); -let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi(); +let apiInstance = new salesforce-marketing-cloud-sdk.TransactionalMessagingApi(); let messageKey = "messageKey_example"; // String | Unique identifier of the definition used to track message status. The messageKey can be created automatically when you create a message, or you can provide it as part of the request. Each recipient in a request must have a unique messageKey. If you use a duplicate messageKey in the same send request, the message is rejected. -let body = new SalesforceMarketingCloud.SendSmsToSingleRecipientRequest(); // SendSmsToSingleRecipientRequest | JSON Parameters +let body = new salesforce-marketing-cloud-sdk.SendSmsToSingleRecipientRequest(); // SendSmsToSingleRecipientRequest | JSON Parameters apiInstance.sendSmsToSingleRecipient(messageKey, body).then((data) => { console.log('API called successfully. Returned data: ' + data); diff --git a/docs/UpdateEmailDefinitionRequest.md b/docs/UpdateEmailDefinitionRequest.md index 185dd11..27ccd58 100644 --- a/docs/UpdateEmailDefinitionRequest.md +++ b/docs/UpdateEmailDefinitionRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.UpdateEmailDefinitionRequest +# salesforce-marketing-cloud-sdk.UpdateEmailDefinitionRequest ## Properties Name | Type | Description | Notes diff --git a/docs/UpdateSmsDefinitionRequest.md b/docs/UpdateSmsDefinitionRequest.md index 0502e06..63b944c 100644 --- a/docs/UpdateSmsDefinitionRequest.md +++ b/docs/UpdateSmsDefinitionRequest.md @@ -1,4 +1,4 @@ -# SalesforceMarketingCloud.UpdateSmsDefinitionRequest +# salesforce-marketing-cloud-sdk.UpdateSmsDefinitionRequest ## Properties Name | Type | Description | Notes diff --git a/src/index.js b/src/index.js index 0deabb0..f778870 100644 --- a/src/index.js +++ b/src/index.js @@ -59,9 +59,9 @@ const TransactionalMessagingApi = require ('./Api/TransactionalMessagingApi'); *

* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: * 

-* var SalesforceMarketingCloud = require('index'); // See note below*.
-* var xxxSvc = new SalesforceMarketingCloud.XxxApi(); // Allocate the API class we're going to use.
-* var yyyModel = new SalesforceMarketingCloud.Yyy(); // Construct a model instance.
+* var salesforce-marketing-cloud-sdk = require('index'); // See note below*.
+* var xxxSvc = new salesforce-marketing-cloud-sdk.XxxApi(); // Allocate the API class we're going to use.
+* var yyyModel = new salesforce-marketing-cloud-sdk.Yyy(); // Construct a model instance.
 * yyyModel.someProperty = 'someValue';
 * ...
 * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
@@ -73,8 +73,8 @@ const TransactionalMessagingApi = require ('./Api/TransactionalMessagingApi');
 * 

 * A non-AMD browser application (discouraged) might do something like this:
 * 
-* var xxxSvc = new SalesforceMarketingCloud.XxxApi(); // Allocate the API class we're going to use.
-* var yyy = new SalesforceMarketingCloud.Yyy(); // Construct a model instance.
+* var xxxSvc = new salesforce-marketing-cloud-sdk.XxxApi(); // Allocate the API class we're going to use.
+* var yyy = new salesforce-marketing-cloud-sdk.Yyy(); // Construct a model instance.
 * yyyModel.someProperty = 'someValue';
 * ...
 * var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.