Skip to content
This repository has been archived by the owner on Jan 20, 2024. It is now read-only.

Commit

Permalink
Auto-update
Browse files Browse the repository at this point in the history
  • Loading branch information
Travis CI User committed Nov 13, 2019
1 parent 88898f7 commit 434538f
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 53 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# This project is under development

# salesforce-marketing-cloud-sdk
# SalesforceMarketingCloud

SalesforceMarketingCloud - JavaScript client for salesforce-marketing-cloud-sdk
SalesforceMarketingCloud - 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:

Expand All @@ -22,7 +22,7 @@ please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.co
Then install it via:

```shell
npm install salesforce-marketing-cloud-sdk --save
npm install SalesforceMarketingCloud --save
```

#### git
Expand All @@ -43,8 +43,8 @@ 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('salesforce-marketing-cloud-sdk');
const Client = require('salesforce-marketing-cloud-sdk/src/Api/Client');
const SalesforceMarketingCloud = require('SalesforceMarketingCloud');
const Client = require('SalesforceMarketingCloud/src/Api/Client');

let client = new Client();
let assetApi = client.assetApi;
Expand Down Expand Up @@ -76,8 +76,8 @@ createAssetResult.then(data => {
#### Using the Client class with the configuration passed through a configuration object

```javascript
const SalesforceMarketingCloud = require('salesforce-marketing-cloud-sdk');
const Client = require('salesforce-marketing-cloud-sdk/src/Api/Client');
const SalesforceMarketingCloud = require('SalesforceMarketingCloud');
const Client = require('SalesforceMarketingCloud/src/Api/Client');

const config = {
authBaseUrl: 'YOUR AUTH BASE URL',
Expand Down
8 changes: 4 additions & 4 deletions docs/AssetApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Creates a new asset.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.AssetApi();

Expand Down Expand Up @@ -63,7 +63,7 @@ Deletes an asset.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.AssetApi();

Expand Down Expand Up @@ -106,7 +106,7 @@ Gets an asset by ID.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.AssetApi();

Expand Down Expand Up @@ -149,7 +149,7 @@ Updates part of an asset.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.AssetApi();

Expand Down
6 changes: 3 additions & 3 deletions docs/CampaignApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Creates a campaign.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.CampaignApi();

Expand Down Expand Up @@ -62,7 +62,7 @@ Deletes a campaign.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.CampaignApi();

Expand Down Expand Up @@ -105,7 +105,7 @@ Retrieves a campaign.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.CampaignApi();

Expand Down
52 changes: 26 additions & 26 deletions docs/TransactionalMessagingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Creates the definition for an email.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -81,7 +81,7 @@ Creates the definition for an SMS.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -124,7 +124,7 @@ Deletes an email definition. You can't restore a deleted definition. The del

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -167,7 +167,7 @@ Deletes the queue for an email definition. The email definition must be in inact

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -210,7 +210,7 @@ Deletes the queue for a SMS definition. The SMS definition must be in inactive s

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -253,7 +253,7 @@ Deletes an sms definition. You can't restore a deleted definition. The delet

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -296,7 +296,7 @@ Gets email definition configuration details for a definition key.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -339,12 +339,12 @@ Gets a list of email definitions.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

let opts = {
'status': "status_example", // String | Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq.
'filter': "filter_example", // String | Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq.
'pageSize': 8.14, // Number | Number of definitions, which are array elements, to return per paged response.
'page': 8.14, // Number | Page number to return.
'orderBy': "orderBy_example" // String | Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status.
Expand All @@ -361,7 +361,7 @@ apiInstance.getEmailDefinitions(opts).then((data) => {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | **String**| Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. | [optional]
**filter** | **String**| Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. | [optional]
**pageSize** | **Number**| Number of definitions, which are array elements, to return per paged response. | [optional]
**page** | **Number**| Page number to return. | [optional]
**orderBy** | **String**| Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status. | [optional]
Expand Down Expand Up @@ -389,7 +389,7 @@ Gets the send status for a message. Because this route is rate-limited, use it f

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -432,7 +432,7 @@ Gets a paginated list of messages that were not sent, ordered from oldest to new

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -481,7 +481,7 @@ Gets metrics for the messages of an email definition. Applies to messages that a

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -524,7 +524,7 @@ Gets metrics for the messages of a SMS definition. Applies to messages that are

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -567,7 +567,7 @@ Gets a paginated list of messages that were not sent, ordered from oldest to new

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -616,7 +616,7 @@ Gets SMS definition configuration details for a definition key.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -659,12 +659,12 @@ Gets a list of SMS definitions.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

let opts = {
'status': "status_example", // String | Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq.
'filter': "filter_example", // String | Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq.
'pageSize': 8.14, // Number | Number of definitions, which are array elements, to return per paged response.
'page': 8.14, // Number | Page number to return.
'orderBy': "orderBy_example" // String | Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status.
Expand All @@ -681,7 +681,7 @@ apiInstance.getSmsDefinitions(opts).then((data) => {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | **String**| Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. | [optional]
**filter** | **String**| Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. | [optional]
**pageSize** | **Number**| Number of definitions, which are array elements, to return per paged response. | [optional]
**page** | **Number**| Page number to return. | [optional]
**orderBy** | **String**| Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status. | [optional]
Expand Down Expand Up @@ -709,7 +709,7 @@ Gets the send status for a message. Because this route is rate-limited, use it f

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -752,7 +752,7 @@ Updates a specific email definition.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -798,7 +798,7 @@ Updates a specific SMS definition.

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -844,7 +844,7 @@ Sends a message to multiple recipients using an email definition. You can provid

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -887,7 +887,7 @@ Sends a message to a single recipient via an email definition using a messageKey

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -933,7 +933,7 @@ Sends a message to multiple recipients using an email definition. You can provid

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down Expand Up @@ -976,7 +976,7 @@ Sends a message to a single recipient via a SMS definition using a messageKey pa

### Example
```javascript
const SalesforceMarketingCloud = require ('salesforce-marketing-cloud-sdk');
const SalesforceMarketingCloud = require ('SalesforceMarketingCloud');

let apiInstance = new SalesforceMarketingCloud.TransactionalMessagingApi();

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "salesforce-marketing-cloud-sdk",
"name": "SalesforceMarketingCloud",
"version": "1.0.0",
"description": "Marketing_Clouds_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_",
"license": "Apache 2.0",
Expand Down
Loading

0 comments on commit 434538f

Please sign in to comment.