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

Automated release 1.0 #16

Open
wants to merge 1 commit into
base: 1.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/CampaignApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**createCampaign**](CampaignApi.md#createCampaign) | **POST** /hub/v1/campaigns | createCampaign
[**deleteCampaignById**](CampaignApi.md#deleteCampaignById) | **DELETE** /hub/v1/campaigns/{id} | deleteCampaignById
[**getAllCampaigns**](CampaignApi.md#getAllCampaigns) | **GET** /hub/v1/campaigns | getAllCampaigns
[**getCampaignById**](CampaignApi.md#getCampaignById) | **GET** /hub/v1/campaigns/{id} | getCampaignById


Expand Down Expand Up @@ -90,6 +91,43 @@ null (empty response body)

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

<a name="getAllCampaigns"></a>
# **getAllCampaigns**
> GetAllCampaignsResponse getAllCampaigns()

getAllCampaigns

Gets all campaigns.

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

let apiInstance = new SalesforceMarketingCloud.CampaignApi();
apiInstance.getAllCampaigns().then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});

```

### Parameters
This endpoint does not need any parameter.

### Return type

[**GetAllCampaignsResponse**](GetAllCampaignsResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
Expand Down
11 changes: 11 additions & 0 deletions docs/GetAllCampaignsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SalesforceMarketingCloud.GetAllCampaignsResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**items** | [**[Campaign]**](Campaign.md) | | [optional]
**count** | **Number** | Number of pages | [optional]
**page** | **Number** | Page number to return. | [optional]
**pageSize** | **Number** | Number of campaigns, which are array elements, to return per paged response. | [optional]


2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "salesforce-marketing-cloud-sdk",
"version": "1.0.0",
"version": "1.1.0",
"description": "The Salesforce Marketing Cloud Node.js SDK",
"license": "BSD-3-Clause",
"main": "src/index.js",
Expand Down
4 changes: 2 additions & 2 deletions src/Api/AssetApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -19,7 +19,7 @@ const BaseApi = require('./BaseApi');
/**
* Asset service.
* @module Api/AssetApi
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class AssetApi extends BaseApi {

Expand Down
48 changes: 46 additions & 2 deletions src/Api/CampaignApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -14,12 +14,13 @@

const ApiError = require ('../Model/ApiError');
const Campaign = require ('../Model/Campaign');
const GetAllCampaignsResponse = require ('../Model/GetAllCampaignsResponse');
const BaseApi = require('./BaseApi');

/**
* Campaign service.
* @module Api/CampaignApi
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class CampaignApi extends BaseApi {

Expand Down Expand Up @@ -137,6 +138,49 @@ module.exports = class CampaignApi extends BaseApi {
}


/**
* getAllCampaigns
* Gets all campaigns.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:Model/GetAllCampaignsResponse} and HTTP response
*/
getAllCampaignsWithHttpInfo(caller, ) {
let postBody = null;


let pathParams = {
};
let queryParams = {
};
let headerParams = {
};
let formParams = {
};

let authName = '';
let contentTypes = [];
let accepts = [];
let returnType = Object;

return this.apiClient.callApi(
'/hub/v1/campaigns', 'GET',
pathParams, queryParams, headerParams, formParams, postBody,
authName, contentTypes, accepts, returnType, caller
);
}

/**
* getAllCampaigns
* Gets all campaigns.
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:Model/GetAllCampaignsResponse}
*/
getAllCampaigns() {
return this.getAllCampaignsWithHttpInfo('getAllCampaigns', )
.then(function(response_and_data) {
return response_and_data.data;
});
}


/**
* getCampaignById
* Retrieves a campaign.
Expand Down
4 changes: 2 additions & 2 deletions src/Api/TransactionalMessagingApi.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand Down Expand Up @@ -35,7 +35,7 @@ const BaseApi = require('./BaseApi');
/**
* TransactionalMessaging service.
* @module Api/TransactionalMessagingApi
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class TransactionalMessagingApi extends BaseApi {

Expand Down
4 changes: 2 additions & 2 deletions src/ApiClient.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -19,7 +19,7 @@ const ApiExceptionFactory = require('./Exception/ApiExceptionFactory');

/**
* @module ApiClient
* @version 1.0.0
* @version 1.1.0
*/

/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/ApiError.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The ApiError model module.
* @module Model/ApiError
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class ApiError{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/Asset.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -25,7 +25,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The Asset model module.
* @module Model/Asset
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class Asset{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/AssetType.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The AssetType model module.
* @module Model/AssetType
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class AssetType{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/Attributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The Attributes model module.
* @module Model/Attributes
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class Attributes{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/Campaign.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The Campaign model module.
* @module Model/Campaign
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class Campaign{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/DeleteQueuedMessagesForSendDefinitionResponse.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The DeleteQueuedMessagesForSendDefinitionResponse model module.
* @module Model/DeleteQueuedMessagesForSendDefinitionResponse
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class DeleteQueuedMessagesForSendDefinitionResponse{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/DeleteSendDefinitionResponse.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The DeleteSendDefinitionResponse model module.
* @module Model/DeleteSendDefinitionResponse
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class DeleteSendDefinitionResponse{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/EmailDefinition.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -26,7 +26,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The EmailDefinition model module.
* @module Model/EmailDefinition
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class EmailDefinition{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/EmailDefinitionContent.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The EmailDefinitionContent model module.
* @module Model/EmailDefinitionContent
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class EmailDefinitionContent{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/EmailDefinitionOptions.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The EmailDefinitionOptions model module.
* @module Model/EmailDefinitionOptions
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class EmailDefinitionOptions{
/**
Expand Down
4 changes: 2 additions & 2 deletions src/Model/EmailDefinitionSubscriptions.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Marketing Cloud REST API
* 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.
*
* OpenAPI spec version: 1.0.0
* OpenAPI spec version: 1.1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
Expand All @@ -23,7 +23,7 @@ const InvalidModelException = require('../Exception/InvalidModelException');
/**
* The EmailDefinitionSubscriptions model module.
* @module Model/EmailDefinitionSubscriptions
* @version 1.0.0
* @version 1.1.0
*/
module.exports = class EmailDefinitionSubscriptions{
/**
Expand Down
Loading