Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexanderwe authored Jun 22, 2018
1 parent 5377715 commit 3c6af40
Showing 1 changed file with 10 additions and 68 deletions.
78 changes: 10 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Add this dependency to your pom.xml to use **bananaj** in your project.
<dependency>
<groupId>com.github.alexanderwe</groupId>
<artifactId>bananaj</artifactId>
<version>1.2.4-alpha</version>
<version>0.5.0</version>
</dependency>
```

Expand Down Expand Up @@ -103,7 +103,7 @@ fileManager.upload("folder_id","filename", myFile);
## Download a file
To download a file from the MailChimp File Manager you have to specifiy the file you want to download and the directory in which it should be saved after download. The file extension is set automatically.
```
fileManager.getFileManagerFile("fileID").downloadFile("./") //Download a file in the current directory
fileManager.getFileManagerFile("fileID").download("./") //Download a file in the current directory
```

## Methods
Expand All @@ -121,75 +121,17 @@ Every endpoint supports GET, POST, and DELETE requests. So it is possible to ful
- **"https://"+server+".api.mailchimp.com/3.0/file-manager/folders"**
- **"https://"+server+".api.mailchimp.com/3.0/file-manager/files"**


# Package structure
```
|-- com.github.alexanderwe.bananaj.connection
| |-- Account.java
| |-- Connection.java
| `-- MailChimpConnection.java
|-- com.github.alexanderwe.bananaj.exceptions
| |-- EmailException.java
| |-- FileFormatException.java
| `-- SegmentException.java
|-- com.github.alexanderwe.bananaj.model
| |-- MailchimpObject.java
| |-- automation
| | |-- Automation.java
| | `-- AutomationStatus.java
| |-- campaign
| | |-- Bounce.java
| | |-- Campaign.java
| | |-- CampaignContent.java
| | |-- CampaignDefaults.java
| | |-- CampaignFolder.java
| | |-- CampaignSettings.java
| | |-- CampaignStatus.java
| | `-- CampaignType.java
| |-- conversation
| | `-- Conversation.java
| |-- filemanager
| | |-- FileManager.java
| | |-- FileManagerFile.java
| | `-- FileManagerFolder.java
| |-- list
| | |-- GrowthHistory.java
| | |-- MailChimpList.java
| | |-- member
| | | |-- Member.java
| | | |-- MemberActivity.java
| | | `-- MemberStatus.java
| | |-- mergefield
| | | |-- MergeField.java
| | | `-- MergeFieldOptions.java
| | `-- segment
| | |-- Condition.java
| | |-- MatchType.java
| | |-- Operator.java
| | |-- Options.java
| | |-- Segment.java
| | `-- SegmentType.java
| |-- report
| | |-- Click.java
| | |-- FacebookLikes.java
| | |-- Forward.java
| | |-- IndustryStats.java
| | |-- Open.java
| | |-- Report.java
| | `-- ReportListStats.java
| `-- template
| |-- Template.java
| |-- TemplateFolder.java
| `-- TemplateType.java
`-- com.github.alexanderwe.bananaj.utils
|-- DateConverter.java
|-- EmailValidator.java
`-- FileInspector.java
```

# To do
- Add missing edit function to the different endpoints

# Contributors

Thanks a lot to all contributors:

* (gscriver)[https://github.com/gscriver]
* (bphilipnyc)[https://github.com/bphilipnyc]
* (icu222much)[https://github.com/icu222much]

# License
The MIT License (MIT)

Expand Down

0 comments on commit 3c6af40

Please sign in to comment.