{"id":18337746,"url":"https://github.com/moosend/api-wrappers-java","last_synced_at":"2025-04-09T20:18:33.905Z","repository":{"id":8824250,"uuid":"10524235","full_name":"moosend/api-wrappers-java","owner":"moosend","description":"Moosend API JAVA Wrapper","archived":false,"fork":false,"pushed_at":"2017-10-03T15:15:31.000Z","size":3281,"stargazers_count":0,"open_issues_count":0,"forks_count":3,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-04-09T20:18:30.189Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moosend.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-06-06T10:36:51.000Z","updated_at":"2017-10-03T15:15:33.000Z","dependencies_parsed_at":"2022-09-19T08:02:29.887Z","dependency_job_id":null,"html_url":"https://github.com/moosend/api-wrappers-java","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moosend%2Fapi-wrappers-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moosend%2Fapi-wrappers-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moosend%2Fapi-wrappers-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moosend%2Fapi-wrappers-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moosend","download_url":"https://codeload.github.com/moosend/api-wrappers-java/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103910,"owners_count":21048246,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T20:12:10.372Z","updated_at":"2025-04-09T20:18:33.828Z","avatar_url":"https://github.com/moosend.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Moosend Java Wrapper for Moosend V3 API\n\n## Requirements\n\nBuilding the API client library requires [Maven](https://maven.apache.org/) to be installed.\n\n## Installation\n\nTo install the API client library to your local Maven repository, simply execute:\n\n```shell\nmvn install \n```\n\nRefer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.\n\n### Maven users\n\nAdd this dependency to your project's POM:\n\n```xml\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003ejitpack.io\u003c/id\u003e\n        \u003curl\u003ehttps://jitpack.io\u003c/url\u003e\n    \u003c/repository\u003e\n  \u003c/repositories\u003e\n\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.moosendr\u003c/groupId\u003e\n    \u003cartifactId\u003eapi-wrappers-java\u003c/artifactId\u003e\n    \u003cversion\u003ev3.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle users\n\nAdd this dependency to your project's build file:\n\n```groovy\ncompile \"io.swagger:swagger-java-client:1.0.0\"\n```\n\n### Others\n\nAt first generate the JAR by executing:\n\n    mvn package\n\nThen manually install the following JARs:\n\n* target/api-wrappers-java-3.0.0.jar\n* target/lib/*.jar\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following Java code:\n\n```java\n\nimport io.swagger.client.*;\nimport io.swagger.client.auth.*;\nimport io.swagger.client.model.*;\nimport io.swagger.client.api.CampaignsApi;\n\nimport java.io.File;\nimport java.util.*;\n\npublic class CampaignsApiExample {\n\n    public static void main(String[] args) {\n        \n        CampaignsApi apiInstance = new CampaignsApi();\n        String format = \"format_example\"; // String | \n        String apikey = \"apikey_example\"; // String | You may find your API Key or generate a new one in your account settings.\n        String campaignID = \"campaignID_example\"; // String | The ID of the requested AB test campaign\n        try {\n            AbTestCampaignSummaryResponse result = apiInstance.aBTestCampaignSummary(format, apikey, campaignID);\n            System.out.println(result);\n        } catch (ApiException e) {\n            System.err.println(\"Exception when calling CampaignsApi#aBTestCampaignSummary\");\n            e.printStackTrace();\n        }\n    }\n}\n\n```\n## Documentation for API Endpoints\n\n## *CampaignsApi*\nClass | Method \n------------ | ------------- \n[**GetAllCampaigns**](docs/CampaignsApi.md#getallcampaigns) | Returns a list of all campaigns in your account with detailed information.  \n[**GetCampaignsByPage**](docs/CampaignsApi.md#getcampaignsbypage) | Returns a list of all campaigns in your account with detailed information, paging information is required as input.\n[**GetCampaignsByPageAndPagesize**](docs/CampaignsApi.md#getcampaignsbypageandpagesize) | Returns a list of all campaigns in your account with detailed information, paging information is required as input.\n[**GettingCampaignDetails**](docs/CampaignsApi.md#gettingcampaigndetails) | Returns a complete set of properties that describe the requested campaign in detail.  \n[**GettingSenderDetails**](docs/CampaignsApi.md#gettingsenderdetails) | Returns basic information for the specified sender identified by its email address.\n[**CloningAnExistingCampaign**](docs/CampaignsApi.md#cloninganexistingcampaign) | Creates an exact copy of an existing campaign. The new campaign is created as a draft.\n[**CreatingADraftCampaign**](docs/CampaignsApi.md#creatingadraftcampaign) | Creates a new campaign in your account. This method does not send the campaign, but rather creates it as a draft, ready for sending or testing. \n[**UpdatingADraftCampaign**](docs/CampaignsApi.md#updatingadraftcampaign) | Updates properties of an existing draft A/B campaign in your account. Non-draft campaigns cannot be updated. \n[**DeletingACampaign**](docs/CampaignsApi.md#deletingacampaign) | Deletes a campaign from your account, draft or even sent.\n[**TestingACampaign**](docs/CampaignsApi.md#testingacampaign) | Sends a test email of a draft campaign to a list of email addresses you specify for previewing.\n[**SendingACampaign**](docs/CampaignsApi.md#sendingacampaign) | Sends an existing draft campaign to all recipients specified in its mailing list. The campaign is sent immediatelly.\n[**ABTestCampaignSummary**](docs/CampaignsApi.md#abtestcampaignsummary) |  Provides a basic summary of the results for a sent AB test campaign, separately for each version (A and B), such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc to date.\n[**ActivityByLocation**](docs/CampaignsApi.md#activitybylocation) |  Returns a detailed report of your campaign opens (unique and total) by country.\n[**CampaignSummary**](docs/CampaignsApi.md#campaignsummary) | Provides a basic summary of the results for any sent campaign such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc. to date.\n[**GettingAllYourSenders**](docs/CampaignsApi.md#gettingallyoursenders) | Gets a list of your active senders in your account. You may specify any email address of these senders when sending a campaign.\n[**LinkActivity**](docs/CampaignsApi.md#linkactivity) | Returns a list with your campaign links and how many clicks have been made by your recipients, either unique or total.\n[**SchedulingACampaign**](docs/CampaignsApi.md#schedulingacampaign) | Assigns a scheduled date and time at which the campaign will be delivered.\n[**UnschedulingACampaign**](docs/CampaignsApi.md#unschedulingacampaign) | Removes a previously defined scheduled date and time from a campaign, so that it will be delivered immediately if already queued or when sent.\n\n## *MailingListsApi*\nClass | Method \n------------ | ------------- \n[**CreatingACustomField**](docs/MailingListsApi.md#creatingacustomfield) | Creates a new custom field in the specified mailing list.\n[**CreatingAMailingList**](docs/MailingListsApi.md#creatingamailinglist) | Creates a new empty mailing list in your account.\n[**DeletingAMailingList**](docs/MailingListsApi.md#deletingamailinglist) | Deletes a mailing list from your account.\n[**GettingAllActiveMailingLists**](docs/MailingListsApi.md#gettingallactivemailinglists) | Gets a list of your active mailing lists in your account.\n[**GettingAllActiveMailingListsWithPaging**](docs/MailingListsApi.md#gettingallactivemailinglistswithpaging) | Gets a list of your active mailing lists in your account. Because the results for this call could be quite big, paging information is required as input.\n[**GettingMailingListDetails**](docs/MailingListsApi.md#gettingmailinglistdetails) | Gets details for a given mailing list. You may include subscriber statistics in your results or not. Any segments existing for the requested mailing list will not be included in the results.\n[**RemovingACustomField**](docs/MailingListsApi.md#removingacustomfield) | Removes a custom field definition from the specified mailing list.\n[**UpdatingACustomField**](docs/MailingListsApi.md#updatingacustomfield) | Updates the properties of an existing custom field in the specified mailing list.\n[**UpdatingAMailingList**](docs/MailingListsApi.md#updatingamailinglist) | Updates the properties of an existing mailing list.\n\n## *SegmentsApi*\nClass | Method \n------------ | ------------- \n[**GettingSegments**](docs/SegmentsApi.md#gettingsegments) | Get a list of all segments with their criteria for the given mailing list.\n[**GettingSegmentDetails**](docs/SegmentsApi.md#gettingsegmentdetails) | Gets detailed information on a specific segment and its criteria. However, it does not include the subscribers returned by the segment.\n[**GettingSegmentSubscribers**](docs/SegmentsApi.md#gettingsegmentsubscribers) | Gets a list of the subscribers that the specified segment returns according to its criteria. Because the results for this call could be quite big, paging information is required as input.\n[**CreatingANewSegment**](docs/SegmentsApi.md#creatinganewsegment) | Creates a new empty segment (without criteria) for the given mailing list. You may specify the name of the segment and the way the criteria will match together.\n[**UpdatingASegment**](docs/SegmentsApi.md#updatingasegment) | Updates the properties of an existing segment. You may update the name and match type of the segment.\n[**AddingCriteriaToSegments**](docs/SegmentsApi.md#addingcriteriatosegments) | Adds a new criterion (a rule) to the specified segment.\n[**UpdatingSegmentCriteria**](docs/SegmentsApi.md#updatingsegmentcriteria) | Updates an existing criterion in the specified segment.\n[**DeletingASegment**](docs/SegmentsApi.md#deletingasegment) | Deletes a segment along with its criteria from the mailing list. The subscribers of the mailing list that the segment returned are not deleted or affected in any way.\n\n## *SubscribersApi*\nClass | Method \n------------ | ------------- \n[**GettingSubscribers**](docs/SubscribersApi.md#gettingsubscribers) | Gets a list of all subscribers in a given mailing list. You may filter the list by setting a date to fetch those subscribed since then and/or by their status. \n[**GetSubscriberByEmailAddress**](docs/SubscribersApi.md#getsubscriberbyemailaddress) | Searches for a subscriber with the specified email address in the specified mailing list.\n[**GetSubscriberById**](docs/SubscribersApi.md#getsubscriberbyid) | Searches for a subscriber with the specified unique id in the specified mailing list\n[**AddingSubscribers**](docs/SubscribersApi.md#addingsubscribers) | Adds a new subscriber to the specified mailing list. If there is already a subscriber with the specified email address in the list, an update will be performed instead.\n[**AddingMultipleSubscribers**](docs/SubscribersApi.md#addingmultiplesubscribers) | This method allows you to add multiple subscribers in a mailing list with a single call. If some subscribers already exist with the given email addresses, they will be updated. \n[**UpdatingASubscriber**](docs/SubscribersApi.md#updatingasubscriber) | Updates a subscriber in the specified mailing list. You can even update the subscribers email, if he has not unsubscribed.\n[**UnsubscribingSubscribersFromAccount**](docs/SubscribersApi.md#unsubscribingsubscribersfromaccount) | Unsubscribes a subscriber from the account.\n[**UnsubscribingSubscribersFromMailingList**](docs/SubscribersApi.md#unsubscribingsubscribersfrommailinglist) | Unsubscribes a subscriber from the specified mailing list. The subscriber is not deleted, but moved to the suppression list.\n[**UnsubscribingSubscribersFromMailingListAndASpecifiedCampaign**](docs/SubscribersApi.md#unsubscribingsubscribersfrommailinglistandaspecifiedcampaign) | Unsubscribes a subscriber from the specified mailing list and the specified campaign. The subscriber is not deleted, but moved to the suppression list. \n[**RemovingASubscriber**](docs/SubscribersApi.md#removingasubscriber) | Removes a subscriber from the specified mailing list permanently (without moving to the suppression list).\n[**RemovingMultipleSubscribers**](docs/SubscribersApi.md#removingmultiplesubscribers) | Removes a list of subscribers from the specified mailing list permanently (without putting them in the suppression list). Any invalid email addresses specified will be ignored.\n\n\n\n## Documentation for Models\n\n - [A](docs/A.md)\n - [ABCampaignData](docs/ABCampaignData.md)\n - [AbTestCampaignSummaryResponse](docs/AbTestCampaignSummaryResponse.md)\n - [ActivityByLocationResponse](docs/ActivityByLocationResponse.md)\n - [AddingCriteriaToSegmentsRequest](docs/AddingCriteriaToSegmentsRequest.md)\n - [AddingCriteriaToSegmentsResponse](docs/AddingCriteriaToSegmentsResponse.md)\n - [AddingMultipleSubscribersRequest](docs/AddingMultipleSubscribersRequest.md)\n - [AddingMultipleSubscribersResponse](docs/AddingMultipleSubscribersResponse.md)\n - [AddingSubscribersRequest](docs/AddingSubscribersRequest.md)\n - [AddingSubscribersResponse](docs/AddingSubscribersResponse.md)\n - [Analytic](docs/Analytic.md)\n - [B](docs/B.md)\n - [Campaign](docs/Campaign.md)\n - [CampaignSummaryResponse](docs/CampaignSummaryResponse.md)\n - [CloningAnExistingCampaignResponse](docs/CloningAnExistingCampaignResponse.md)\n - [Context](docs/Context.md)\n - [Context110](docs/Context110.md)\n - [Context118](docs/Context118.md)\n - [Context132](docs/Context132.md)\n - [Context140](docs/Context140.md)\n - [Context145](docs/Context145.md)\n - [Context148](docs/Context148.md)\n - [Context17](docs/Context17.md)\n - [Context32](docs/Context32.md)\n - [Context37](docs/Context37.md)\n - [Context52](docs/Context52.md)\n - [Context64](docs/Context64.md)\n - [Context66](docs/Context66.md)\n - [Context72](docs/Context72.md)\n - [Context84](docs/Context84.md)\n - [Context89](docs/Context89.md)\n - [Context93](docs/Context93.md)\n - [CreatingACustomFieldRequest](docs/CreatingACustomFieldRequest.md)\n - [CreatingACustomFieldResponse](docs/CreatingACustomFieldResponse.md)\n - [CreatingADraftCampaignRequest](docs/CreatingADraftCampaignRequest.md)\n - [CreatingADraftCampaignResponse](docs/CreatingADraftCampaignResponse.md)\n - [CreatingAMailingListRequest](docs/CreatingAMailingListRequest.md)\n - [CreatingAMailingListResponse](docs/CreatingAMailingListResponse.md)\n - [CreatingANewSegmentRequest](docs/CreatingANewSegmentRequest.md)\n - [CreatingANewSegmentResponse](docs/CreatingANewSegmentResponse.md)\n - [Criterion](docs/Criterion.md)\n - [CustomField](docs/CustomField.md)\n - [CustomField53](docs/CustomField53.md)\n - [CustomFieldsDefinition](docs/CustomFieldsDefinition.md)\n - [DeletingACampaignResponse](docs/DeletingACampaignResponse.md)\n - [DeletingAMailingListResponse](docs/DeletingAMailingListResponse.md)\n - [DeletingASegmentResponse](docs/DeletingASegmentResponse.md)\n - [Format](docs/Format.md)\n - [GetAllCampaignsResponse](docs/GetAllCampaignsResponse.md)\n - [GetCampaignStatisticsResponse](docs/GetCampaignStatisticsResponse.md)\n - [GetCampaignStatisticsWithPagingFilteredResponse](docs/GetCampaignStatisticsWithPagingFilteredResponse.md)\n - [GetCampaignsByPageAndPagesizeResponse](docs/GetCampaignsByPageAndPagesizeResponse.md)\n - [GetCampaignsByPageResponse](docs/GetCampaignsByPageResponse.md)\n - [GetSubscriberByEmailAddressResponse](docs/GetSubscriberByEmailAddressResponse.md)\n - [GetSubscriberByIdResponse](docs/GetSubscriberByIdResponse.md)\n - [GettingAllActiveMailingListsResponse](docs/GettingAllActiveMailingListsResponse.md)\n - [GettingAllActiveMailingListsWithPagingResponse](docs/GettingAllActiveMailingListsWithPagingResponse.md)\n - [GettingAllYourSendersResponse](docs/GettingAllYourSendersResponse.md)\n - [GettingCampaignDetailsResponse](docs/GettingCampaignDetailsResponse.md)\n - [GettingMailingListDetailsResponse](docs/GettingMailingListDetailsResponse.md)\n - [GettingSegmentDetailsResponse](docs/GettingSegmentDetailsResponse.md)\n - [GettingSegmentSubscribersResponse](docs/GettingSegmentSubscribersResponse.md)\n - [GettingSegmentsResponse](docs/GettingSegmentsResponse.md)\n - [GettingSenderDetailsResponse](docs/GettingSenderDetailsResponse.md)\n - [GettingSubscribersResponse](docs/GettingSubscribersResponse.md)\n - [ImportOperation](docs/ImportOperation.md)\n - [ImportOperation19](docs/ImportOperation19.md)\n - [LinkActivityResponse](docs/LinkActivityResponse.md)\n - [MailingList](docs/MailingList.md)\n - [MailingList68](docs/MailingList68.md)\n - [MailingList69](docs/MailingList69.md)\n - [MailingList85](docs/MailingList85.md)\n - [MailingLists](docs/MailingLists.md)\n - [MailingLists119](docs/MailingLists119.md)\n - [MailingLists134](docs/MailingLists134.md)\n - [Paging](docs/Paging.md)\n - [Paging76](docs/Paging76.md)\n - [RemovingACustomFieldResponse](docs/RemovingACustomFieldResponse.md)\n - [RemovingASubscriberRequest](docs/RemovingASubscriberRequest.md)\n - [RemovingASubscriberResponse](docs/RemovingASubscriberResponse.md)\n - [RemovingMultipleSubscribersRequest](docs/RemovingMultipleSubscribersRequest.md)\n - [RemovingMultipleSubscribersResponse](docs/RemovingMultipleSubscribersResponse.md)\n - [ReplyToEmail](docs/ReplyToEmail.md)\n - [SchedulingACampaignRequest](docs/SchedulingACampaignRequest.md)\n - [SchedulingACampaignResponse](docs/SchedulingACampaignResponse.md)\n - [Segment](docs/Segment.md)\n - [Sender](docs/Sender.md)\n - [SendingACampaignResponse](docs/SendingACampaignResponse.md)\n - [ShortBy](docs/ShortBy.md)\n - [SortMethod](docs/SortMethod.md)\n - [Status](docs/Status.md)\n - [Subscriber](docs/Subscriber.md)\n - [Subscribers](docs/Subscribers.md)\n - [Subscribers150](docs/Subscribers150.md)\n - [TestingACampaignRequest](docs/TestingACampaignRequest.md)\n - [TestingACampaignResponse](docs/TestingACampaignResponse.md)\n - [Type](docs/Type.md)\n - [UnschedulingACampaignResponse](docs/UnschedulingACampaignResponse.md)\n - [UnsubscribingSubscribersFromAccountRequest](docs/UnsubscribingSubscribersFromAccountRequest.md)\n - [UnsubscribingSubscribersFromAccountResponse](docs/UnsubscribingSubscribersFromAccountResponse.md)\n - [UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignRequest](docs/UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignRequest.md)\n - [UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignResponse](docs/UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignResponse.md)\n - [UnsubscribingSubscribersFromMailingListRequest](docs/UnsubscribingSubscribersFromMailingListRequest.md)\n - [UnsubscribingSubscribersFromMailingListResponse](docs/UnsubscribingSubscribersFromMailingListResponse.md)\n - [UpdatingACustomFieldRequest](docs/UpdatingACustomFieldRequest.md)\n - [UpdatingACustomFieldResponse](docs/UpdatingACustomFieldResponse.md)\n - [UpdatingADraftCampaignRequest](docs/UpdatingADraftCampaignRequest.md)\n - [UpdatingADraftCampaignResponse](docs/UpdatingADraftCampaignResponse.md)\n - [UpdatingAMailingListRequest](docs/UpdatingAMailingListRequest.md)\n - [UpdatingAMailingListResponse](docs/UpdatingAMailingListResponse.md)\n - [UpdatingASegmentRequest](docs/UpdatingASegmentRequest.md)\n - [UpdatingASegmentResponse](docs/UpdatingASegmentResponse.md)\n - [UpdatingASubscriberRequest](docs/UpdatingASubscriberRequest.md)\n - [UpdatingASubscriberResponse](docs/UpdatingASubscriberResponse.md)\n - [UpdatingSegmentCriteriaRequest](docs/UpdatingSegmentCriteriaRequest.md)\n - [UpdatingSegmentCriteriaResponse](docs/UpdatingSegmentCriteriaResponse.md)\n - [WithStatistics](docs/WithStatistics.md)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoosend%2Fapi-wrappers-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoosend%2Fapi-wrappers-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoosend%2Fapi-wrappers-java/lists"}