From adcba18659e38db4f83f069c47bd8c7cebbbc7bc Mon Sep 17 00:00:00 2001 From: Ian Murdock <imurdock@exacttarget.com> Date: Wed, 28 Jan 2015 20:15:39 -0500 Subject: [PATCH] Released version 1.0.1. --- pom.xml | 2 +- .../fuelsdk/ETDataExtensionRow.java | 18 +++ .../com/exacttarget/fuelsdk/package-info.java | 109 ++++++++++++++++++ 3 files changed, 128 insertions(+), 1 deletion(-) create mode 100644 src/main/java/com/exacttarget/fuelsdk/package-info.java diff --git a/pom.xml b/pom.xml index b3d0688a..2b8c0efe 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ <modelVersion>4.0.0</modelVersion> <groupId>com.exacttarget</groupId> <artifactId>fuel-java</artifactId> - <version>1.0.0</version> + <version>1.0.1</version> <packaging>jar</packaging> <name>Fuel Java client library</name> <url>http://code.exacttarget.com</url> diff --git a/src/main/java/com/exacttarget/fuelsdk/ETDataExtensionRow.java b/src/main/java/com/exacttarget/fuelsdk/ETDataExtensionRow.java index e24d7463..58721923 100644 --- a/src/main/java/com/exacttarget/fuelsdk/ETDataExtensionRow.java +++ b/src/main/java/com/exacttarget/fuelsdk/ETDataExtensionRow.java @@ -113,4 +113,22 @@ public String getCustomerKey() { public void setCustomerKey(String customerKey) { setKey(customerKey); } + + /** + * @deprecated + * Use <code>getColumn</code> and <code>setColumn</code>. + */ + @Deprecated + public Map<String, String> getColumns() { + return columns; + } + + /** + * @deprecated + * Use <code>getColumn</code> and <code>setColumn</code>. + */ + @Deprecated + public void setColumns(Map<String, String> columns) { + this.columns = columns; + } } diff --git a/src/main/java/com/exacttarget/fuelsdk/package-info.java b/src/main/java/com/exacttarget/fuelsdk/package-info.java new file mode 100644 index 00000000..abf8e9f0 --- /dev/null +++ b/src/main/java/com/exacttarget/fuelsdk/package-info.java @@ -0,0 +1,109 @@ +/** + * The Java client library enables developers to easily + * access the Salesforce Marketing Cloud (formerly + * ExactTarget) API from the Java platform. Among other + * things, the Java client library: + * + * <ul> + * <li> + * automatically acquires and refreshes Marketing Cloud + * access tokens + * </li> + * <li> + * enables developers to access both Marketing Cloud + * SOAP and REST APIs in the same session + * </li> + * <li> + * exposes simplified versions of the most commonly + * used Marketing Cloud objects and methods as Java + * native objects + * </li> + * <li> + * provides passthroughs so developers can access the full + * REST and SOAP APIs directly when they need to go beyond + * the simplified interfaces + * </li> + * <li> + * adds "sugar" methods for the most commonly used + * Marketing Cloud features that make it easy to use + * those features (e.g., the client library + * provides an SQL like interface to data extensions) + * </li> + * </ul> + * + * To use the Java client library, you first need to + * instantiate an <code>ETClient</code> object: + * + * <pre> + * ETClient client = new ETClient(); + * </pre> + * + * The Java client library is highly configurable. By + * default, configuration is read from a properties file + * named <code>fuelsdk.properties</code>, which should be + * located in your class path. Alternatively, you can + * pass in the path of the file to be read as an + * argument to the <code>ETClient</code> constructor: + * + * <pre> + * ETClient client = new ETClient("/Users/imurdock/fuel.properties"); + * </pre> + * + * You can also pass in a programmatically constructed + * <code>ETConfiguration</code> object: + * + * <pre> + * ETConfiguration configuration = new ETConfiguration(); + * configuration.setClientId("clientIdGoesHere"); + * configuration.setClientSecret("clientSecretGoesHere"); + * + * ETClient client = new ETClient(ETConfiguration); + * </pre> + * + * <p> + * <i>XXX include full list of configuration options</i> + * </p> + * + * <p> + * <i>XXX include overview of logging options</i> + * </p> + * + * Note: For historical reasons, the Java client library + * uses the term "Fuel" and "SDK" in several places, e.g., the + * package name <code>com.exacttarget.fuelsdk</code> and + * exception class name <code>ETSdkException</code>. The + * Fuel client libraries were initially called SDKs and + * implemented before ExactTarget was acquired by + * Salesforce and became the Salesforce Marketing Cloud. + * + * Once the client has been initialized, you interacted + * with the API using its <code>create</code>, <code>retrieve</code>, + * <code>update</code>, and <code>delete</code> methods. + * + * <p> + * <i>XXX include full list of generic methods and common + * properties, e.g. id and key</i> + * </p> + * + * In addition, some objects (e.g., <code>ETDataExtension</code> + * and <code>ETTriggeredEmail</code> contain object native + * methods (e.g., <code>insert</code>, <code>select</code>, + * <code>update</code>, and <code>delete</code> + * for <code>ETDataExtension</code> and <code>send</code> for + * <code>TriggeredEmail). For information on these + * object native methods please see the class documentation.. + * + * <p> + * <i>XXX include overview of filter strings</i> + * </p> + * + * <p> + * <i>XXX include overview of ETResponse / ETResult</i> + * </p> + * + * <p> + * <i>XXX include how to use API passthrough</i> + * </p> + */ + +package com.exacttarget.fuelsdk;