From 434538f818b4252a76c65531c8291e136f5a3b81 Mon Sep 17 00:00:00 2001 From: Travis CI User Date: Wed, 13 Nov 2019 12:47:51 +0000 Subject: [PATCH] Auto-update --- README.md | 14 ++++---- docs/AssetApi.md | 8 ++--- docs/CampaignApi.md | 6 ++-- docs/TransactionalMessagingApi.md | 52 ++++++++++++++-------------- package.json | 2 +- src/Api/TransactionalMessagingApi.js | 24 ++++++------- 6 files changed, 53 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 82df2c5..487ddaa 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 @@ -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; @@ -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', diff --git a/docs/AssetApi.md b/docs/AssetApi.md index f4c40bf..112d29c 100644 --- a/docs/AssetApi.md +++ b/docs/AssetApi.md @@ -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(); @@ -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(); @@ -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(); @@ -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(); diff --git a/docs/CampaignApi.md b/docs/CampaignApi.md index 5e1e511..74746b0 100644 --- a/docs/CampaignApi.md +++ b/docs/CampaignApi.md @@ -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(); @@ -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(); @@ -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(); diff --git a/docs/TransactionalMessagingApi.md b/docs/TransactionalMessagingApi.md index f6dc179..c0b36c2 100644 --- a/docs/TransactionalMessagingApi.md +++ b/docs/TransactionalMessagingApi.md @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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. @@ -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] @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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. @@ -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] @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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(); @@ -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(); diff --git a/package.json b/package.json index 39d5d1d..af83dbb 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/src/Api/TransactionalMessagingApi.js b/src/Api/TransactionalMessagingApi.js index a75f311..d69035d 100644 --- a/src/Api/TransactionalMessagingApi.js +++ b/src/Api/TransactionalMessagingApi.js @@ -411,7 +411,7 @@ module.exports = class TransactionalMessagingApi extends BaseApi { * getEmailDefinitions * Gets a list of email definitions. * @param {Object} opts Optional parameters - * @param {module:Model/String} opts.status Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. + * @param {module:Model/String} opts.filter Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. * @param {Number} opts.pageSize Number of definitions, which are array elements, to return per paged response. * @param {Number} opts.page Page number to return. * @param {module:Model/String} opts.orderBy Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status. @@ -425,10 +425,10 @@ module.exports = class TransactionalMessagingApi extends BaseApi { let pathParams = { }; let queryParams = { - 'status': opts['status'], - 'pageSize': opts['pageSize'], - 'page': opts['page'], - 'orderBy': opts['orderBy'] + '$filter': opts['filter'], + '$pageSize': opts['pageSize'], + '$page': opts['page'], + '$orderBy': opts['orderBy'] }; let headerParams = { }; @@ -451,7 +451,7 @@ module.exports = class TransactionalMessagingApi extends BaseApi { * getEmailDefinitions * Gets a list of email definitions. * @param {Object} opts Optional parameters - * @param {module:Model/String} opts.status Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. + * @param {module:Model/String} opts.filter Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. * @param {Number} opts.pageSize Number of definitions, which are array elements, to return per paged response. * @param {Number} opts.page Page number to return. * @param {module:Model/String} opts.orderBy Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status. @@ -793,7 +793,7 @@ module.exports = class TransactionalMessagingApi extends BaseApi { * getSmsDefinitions * Gets a list of SMS definitions. * @param {Object} opts Optional parameters - * @param {module:Model/String} opts.status Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. + * @param {module:Model/String} opts.filter Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. * @param {Number} opts.pageSize Number of definitions, which are array elements, to return per paged response. * @param {Number} opts.page Page number to return. * @param {module:Model/String} opts.orderBy Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status. @@ -807,10 +807,10 @@ module.exports = class TransactionalMessagingApi extends BaseApi { let pathParams = { }; let queryParams = { - 'status': opts['status'], - 'pageSize': opts['pageSize'], - 'page': opts['page'], - 'orderBy': opts['orderBy'] + '$filter': opts['filter'], + '$pageSize': opts['pageSize'], + '$page': opts['page'], + '$orderBy': opts['orderBy'] }; let headerParams = { }; @@ -833,7 +833,7 @@ module.exports = class TransactionalMessagingApi extends BaseApi { * getSmsDefinitions * Gets a list of SMS definitions. * @param {Object} opts Optional parameters - * @param {module:Model/String} opts.status Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. + * @param {module:Model/String} opts.filter Filter by status type. Accepted values are active, inactive, or deleted. Valid operations are eq and neq. * @param {Number} opts.pageSize Number of definitions, which are array elements, to return per paged response. * @param {Number} opts.page Page number to return. * @param {module:Model/String} opts.orderBy Sort by a dimension. You can sort by only one dimension. Accepted values are definitionKey, name, createdDate, modifiedDate, and status.