Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Simplify and improve the FuelSDK for Salesforce Marketing Cloud (ExactTarget)

Project description

# FuelSDK-Python-Wrapper
Simplify and improve the FuelSDK for Salesforce Marketing Cloud (ExactTarget).

## Overview
The Fuel SDK Wrapper for Python add functionalities to the default Fuel SDK and provides access to more SOAP API objects. The Fuel SDK documentation can be found [here](

## Installation
pip install FuelSDKWrapper

## Getting Started

### Configuring

You must configure your access tokens and details for the Fuel SDK in one of the following two ways.

1. Copy the included `config.python.template` file to `config.python` in either `~/.fuelsdk/`, within this python module or at the root of your project.
2. Add environment variables:
* `FUELSDK_CLIENT_ID` (required)

Edit `config.python` or declare environment variables so you can input the ClientID and Client Secret values provided when you registered your application. If you are building a HubExchange application for the Interactive Marketing Hub then, you must also provide the Application Signature (`appsignature` / `FUELSDK_APP_SIGNATURE`).
The `defaultwsdl` / `FUELSDK_DEFAULT_WSDL` configuration must be [changed depending on the ExactTarget service]( "ExactTarget Forum").
The `authenticationurl` / `FUELSDK_AUTH_URL` must also be [changed depending on service]( "ExactTarget Forum").
The `wsdl_file_local_loc` / `FUELSDK_WSDL_FILE_LOCAL_LOC` allows you to specify the full path/filename where the WSDL file will be located on disk, if for instance you are connecting to different endpoints from the same server.

If you have not registered your application or you need to lookup your Application Key or Application Signature values, please go to App Center at [Code@: ExactTarget's Developer Community]( "Code@ App Center").

| Environment | WSDL (default) | URL (auth) |
| ----------- | -------------- | ---------- |
| Production | | |
| Sandbox | | |

It is also possible to pass those values directly to the API object:
params = {
"clientid": "YOUR_CLIENT_ID",
"clientsecret": "YOUR_CLIENT_SECRET"
api = ET_API(params=params)

## Example Request

### Get the List objects

# Add a require statement to reference the Fuel SDK's functionality:
from FuelSDKWrapper import ET_API, ObjectType

# Next, create an instance of the ET_API class:
api = ET_API()

# Get the List objects:
response = api.get_objects(ObjectType.LIST)

# Print out the results for viewing
print('Post Status: {}'.format(response.status))
print('Code: {}'.format(response.code))
print('Message: {}'.format(response.message))
print('Result Count: {}'.format(len(response.results)))
print('Results: {}'.format(response.results))

### Some examples of utilization

from FuelSDKWrapper import ET_API, ObjectType, Operator, search_filter
from datetime import datetime, timedelta

api = ET_API()

response = api.get_objects(
search_filter("EmailAddress", Operator.EQUALS, "")

response = api.get_objects(
search_filter("Name", Operator.EQUALS, "My_Folder"),
property_list=["ID", "Name"]

dt = - timedelta(days=30)
response = api.get_objects(
search_filter("SendDate", Operator.GREATER_THAN, dt)

### Get More Results

api = ET_API()

response = api.get_objects(ObjectType.SUBSCRIBER)
i = 0
while len(response.results) > 0 and (i == 0 or response.more_results):
if i > 0 and response.more_results:
res = api.continue_request(response.request_id)

for subscriber in response.results:
print("Subscriber: {}".format(subscriber))

### Perform Request

You can Perform the list of actions found [here](

api = ET_API()

response = api.get_objects(
search_filter("Name", Operator.EQUALS, "Import_my_file")
import_def = response.results[0]
response = api.perform_action("start", import_def)
except IndexError:

### List SOAP API Object Properties

api = ET_API()

response = api.get_info(ObjectType.CONTENT_AREA)

### Object Type Missing

In case the Object Type is missing from the ObjectType class, you can use a string directly:
api = ET_API()

response = api.get_objects("AccountUser")

## Responses

All methods on Fuel SDK objects return a generic object that follows the same structure, regardless of the type of call. This object contains a common set of properties used to display details about the request.

| Parameter | Description |
| --------- | --------------------------------------------------------------- |
| status | Boolean value that indicates if the call was successful |
| code | HTTP Error Code (will always be 200 for SOAP requests) |
| message | Text values containing more details in the event of an Error |
| results | Collection containing the details unique to the method called. |

## Debug

To debug any issues, activate the debug mode:
api = ET_API(debug=True)

## Requirements

Python 2.7.x


* FuelSDK>=0.9.3
* PyJWT>=0.1.9
* requests>=2.2.1
* suds>=0.4
* suds-jurko>=0.6

Project details

Release history Release notifications

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
FuelSDKWrapper-0.3.4-py2-none-any.whl (17.4 kB) Copy SHA256 hash SHA256 Wheel py2 Jan 16, 2018
FuelSDKWrapper-0.3.4.tar.gz (11.7 kB) Copy SHA256 hash SHA256 Source None Jan 16, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page