Skip to content

Latest commit

 

History

History
607 lines (557 loc) · 43.2 KB

File metadata and controls

607 lines (557 loc) · 43.2 KB

statflo-java-sdk

Statflo API

  • SDK version: V4.1.200
    • Build date: 2026-06-24T18:33:53.135598835Z[Etc/UTC]

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add the JitPack repository to your build file

<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

Add this dependency to your project's POM:

<dependency>
  <groupId>com.github.Statflo</groupId>
  <artifactId>statflo-java-sdk</artifactId>
  <version>V4.1.200</version>
</dependency>

Gradle users

Add it in your root build.gradle at the end of repositories:

dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add this dependency to your project's build file:

dependencies {
        implementation 'com.github.Statflo:statflo-java-sdk:V4.1.200'
}

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/statflo-java-sdk-V4.1.200.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.statflo.client.ApiClient;
import com.statflo.client.ApiException;
import com.statflo.client.api.AccountActionsApi;
import com.statflo.client.model.AccountActionPaginationResponse;
import com.statflo.client.model.AccountActionSummary;

import java.util.HashMap;

public class AccountActionExample {
    public static void main(String[] args) throws ApiException {
        ApiClient apiClient = new ApiClient();
        apiClient.setBasePath(Config.HOST);
        apiClient.setAccessToken(Config.accessToken);

        AccountActionsApi accountActionsApi = new AccountActionsApi(apiClient);

        HashMap<String, String> filter = new HashMap<>();
        AccountActionPaginationResponse accountActionPaginationResponse = accountActionsApi.accountActionSearch(filter, "", 1, 10, "");
        for (AccountActionSummary item : accountActionPaginationResponse.getItems()) {
            System.out.println(item);
        }
    }
}


import com.statflo.client.ApiClient;
import com.statflo.client.ApiException;
import com.statflo.client.api.CampaignsApi;
import com.statflo.client.model.CampaignPaginationResponse;
import com.statflo.client.model.CampaignSummary;

import java.util.HashMap;

public class CampaignExample {
    public static void main(String[] args) throws ApiException {
        ApiClient apiClient = new ApiClient();
        apiClient.setBasePath(Config.HOST);
        apiClient.setAccessToken(Config.accessToken);

        CampaignsApi campaignsApi = new CampaignsApi(apiClient);
        HashMap<String, String> filter = new HashMap<>();

        CampaignPaginationResponse campaignPaginationResponse = campaignsApi.campaignSearch(filter, "", 1, 10, "");
        for (CampaignSummary campaignSummary : campaignPaginationResponse.getItems()) {
            System.out.println(campaignSummary);
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://app.statflo.com

Class Method HTTP request Description
AccountApi accountCreate POST /v4/api/account
AccountApi accountDelete DELETE /v4/api/account/{id}
AccountApi accountGet GET /v4/api/account/{id}
AccountApi accountSearch GET /v4/api/account
AccountApi accountUpdate PUT /v4/api/account/{id}
AccountActionApi accountActionCreate POST /v4/api/account-action
AccountActionApi accountActionGet GET /v4/api/account-action/{id}
AccountActionApi accountActionSearch GET /v4/api/account-action
AccountContactMetadataApi accountContactMetadata GET /v4/api/account-contact-metadata
AccountContactMetadataApi accountContactMetadataCreate POST /v4/api/account-contact-metadata
AccountContactMetadataApi accountContactMetadataDelete DELETE /v4/api/account-contact-metadata/{id}
AccountContactMetadataApi accountContactMetadataGet GET /v4/api/account-contact-metadata/{id}
AccountContactMetadataApi accountContactMetadataUpdate PUT /v4/api/account-contact-metadata/{id}
AccountCredentialApi accountCredentialCreate POST /v4/api/account-credential
AccountCredentialApi accountCredentialGet GET /v4/api/account-credential/{id}
AccountCredentialApi accountCredentialSearch GET /v4/api/account-credential
AccountCredentialApi accountCredentialUpdate PUT /v4/api/account-credential/{id}
AccountMemberApi accountMemberCreate POST /v4/api/account-member
AccountMemberApi accountMemberDelete DELETE /v4/api/account-member/{id}
AccountMemberApi accountMemberGet GET /v4/api/account-member/{id}
AccountMemberApi accountMemberSearch GET /v4/api/account-member
AccountMemberApi accountMemberUpdate PUT /v4/api/account-member/{id}
AccountNumberApi accountNumberCreate POST /v4/api/account-number
AccountNumberApi accountNumberGet GET /v4/api/account-number/{id}
AccountNumberApi accountNumberSearch GET /v4/api/account-number
AccountNumberApi accountNumberUpdate PUT /v4/api/account-number/{id}
AuthenticationApi authMe GET /v4/api/auth/me
AuthenticationApi login POST /v4/api/auth/login
AuthenticationApi logout GET /v4/api/auth/logout
AuthenticationApi switchDealer GET /v4/api/auth/switch
AuthenticationApi switchDealerPost POST /v4/api/auth/switch
BulkMessageApi bulkMessageCreate POST /v4/api/bulk-message
BulkMessageApi bulkMessageGet GET /v4/api/bulk-message/{id}
BulkMessageApi bulkMessageSearch GET /v4/api/bulk-message
BulkMessageApi bulkMessageUpdate PUT /v4/api/bulk-message/{id}
BulkRequestApi bulkRequest POST /v4/api/bulk
CampaignApi campaignCreate POST /v4/api/campaign
CampaignApi campaignDelete DELETE /v4/api/campaign/{id}
CampaignApi campaignGet GET /v4/api/campaign/{id}
CampaignApi campaignSearch GET /v4/api/campaign
CampaignApi campaignUpdate PUT /v4/api/campaign/{id}
CampaignMappingApi campaignMappingDelete DELETE /v4/api/campaign-mapping/{id}
CampaignMappingApi campaignMappingSearch GET /v4/api/campaign-mapping
CampaignMemberApi campaignMemberCreate POST /v4/api/campaign-member
CampaignMemberApi campaignMemberDelete DELETE /v4/api/campaign-member/{id}
CampaignMemberApi campaignMemberGet GET /v4/api/campaign-member/{id}
CampaignMemberApi campaignMemberSearch GET /v4/api/campaign-member
CampaignMemberApi campaignMemberUpdate PUT /v4/api/campaign-member/{id}
CampaignMetadataApi campaignMetadataCreate POST /v4/api/campaign-metadata
CampaignMetadataApi campaignMetadataDelete DELETE /v4/api/campaign-metadata/{id}
CampaignMetadataApi campaignMetadataGet GET /v4/api/campaign-metadata/{id}
CampaignMetadataApi campaignMetadataSearch GET /v4/api/campaign-metadata
CampaignMetadataApi campaignMetadataUpdate PUT /v4/api/campaign-metadata/{id}
CampaignPropertyApi campaignPropertyCreate POST /v4/api/campaign-property
CampaignPropertyApi campaignPropertyDelete DELETE /v4/api/campaign-property/{id}
CampaignPropertyApi campaignPropertyGet GET /v4/api/campaign-property/{id}
CampaignPropertyApi campaignPropertySearch GET /v4/api/campaign-property
CampaignPropertyApi campaignPropertyUpdate PUT /v4/api/campaign-property/{id}
CarrierApi carrierGet GET /v4/api/carrier/{id}
CarrierApi carrierSearch GET /v4/api/carrier
ConsentApi consentCreate POST /v4/api/consent
ConsentApi consentDelete DELETE /v4/api/consent/{id}
ConsentApi consentGet GET /v4/api/consent/{id}
ConsentApi consentSearch GET /v4/api/consent
ConsentApi consentUpdate PUT /v4/api/consent/{id}
ContactApi contactCreate POST /v4/api/contact
ContactApi contactDelete DELETE /v4/api/contact/{id}
ContactApi contactGet GET /v4/api/contact/{id}
ContactApi contactSearch GET /v4/api/contact
ContactApi contactUpdate PUT /v4/api/contact/{id}
ContentSharingCategoryApi contentSharingCategoryCreate POST /v4/api/content-sharing-category
ContentSharingCategoryApi contentSharingCategoryDelete DELETE /v4/api/content-sharing-category/{id}
ContentSharingCategoryApi contentSharingCategoryGet GET /v4/api/content-sharing-category/{id}
ContentSharingCategoryApi contentSharingCategorySearch GET /v4/api/content-sharing-category
ContentSharingCategoryApi contentSharingCategoryUpdate PUT /v4/api/content-sharing-category/{id}
ContentSharingLinkApi contentSharingLinkCreate POST /v4/api/content-sharing-link
ContentSharingLinkApi contentSharingLinkDelete DELETE /v4/api/content-sharing-link/{id}
ContentSharingLinkApi contentSharingLinkGet GET /v4/api/content-sharing-link/{id}
ContentSharingLinkApi contentSharingLinkSearch GET /v4/api/content-sharing-link
ContentSharingLinkApi contentSharingLinkUpdate PUT /v4/api/content-sharing-link/{id}
ContentSharingRecommendApi contentSharingRecommendedCreate POST /v4/api/content-sharing-recommend
ContentSharingRecommendApi contentSharingRecommendedDelete DELETE /v4/api/content-sharing-recommend/{id}
ContentSharingRecommendApi contentSharingRecommendedGet GET /v4/api/content-sharing-recommend/{id}
ContentSharingRecommendApi contentSharingRecommendedSearch GET /v4/api/content-sharing-recommend
ContentSharingRecommendApi contentSharingRecommendedUpdate PUT /v4/api/content-sharing-recommend/{id}
ConversationApi conversationCreate POST /v4/api/conversation
ConversationApi conversationGet GET /v4/api/conversation/{id}
ConversationApi conversationSearch GET /v4/api/conversation
ConversationApi conversationUpdate PUT /v4/api/conversation/{id}
DealerApi dealerGet GET /v4/api/dealer/{id}
DealerApi dealerSearch GET /v4/api/dealer
DealerAllowedFeatureApi dealerAllowedFeatureCreate POST /v4/api/dealer-allowed-feature
DealerAllowedFeatureApi dealerAllowedFeatureDelete DELETE /v4/api/dealer-allowed-feature/{dealer}/{feature}
DealerAllowedFeatureApi dealerAllowedFeatureGet GET /v4/api/dealer-allowed-feature/{dealer}/{feature}
DealerExternalIdApi dealerExternalIdCreate POST /v4/api/dealer-external-id
DealerExternalIdApi dealerExternalIdDelete DELETE /v4/api/dealer-external-id/{id}
DealerExternalIdApi dealerExternalIdGet GET /v4/api/dealer-external-id/{id}
DealerExternalIdApi dealerExternalIdSearch GET /v4/api/dealer-external-id
DealerExternalIdApi dealerExternalIdUpdate PUT /v4/api/dealer-external-id/{id}
DealerMetadataApi dealerMetadataCreate POST /v4/api/dealer-metadata
DealerMetadataApi dealerMetadataDelete DELETE /v4/api/dealer-metadata/{id}
DealerMetadataApi dealerMetadataGet GET /v4/api/dealer-metadata/{id}
DealerMetadataApi dealerMetadataSearch GET /v4/api/dealer-metadata
DealerMetadataApi dealerMetadataUpdate PUT /v4/api/dealer-metadata/{id}
DistrictApi districtCreate POST /v4/api/district
DistrictApi districtDelete DELETE /v4/api/district/{id}
DistrictApi districtGet GET /v4/api/district/{id}
DistrictApi districtSearch GET /v4/api/district
DistrictApi districtUpdate PUT /v4/api/district/{id}
EventApi events GET /v4/api/event
FeatureApi featureGet GET /v4/api/feature/{id}
FeatureApi featureSearch GET /v4/api/feature
LocationApi locationCreate POST /v4/api/location
LocationApi locationDelete DELETE /v4/api/location/{id}
LocationApi locationGet GET /v4/api/location/{id}
LocationApi locationSearch GET /v4/api/location
LocationApi locationUpdate PUT /v4/api/location/{id}
MessageApi messageCreate POST /v4/api/message
MessageApi messageGet GET /v4/api/message/{id}
MessageApi messageSearch GET /v4/api/message
MessageApi messageUpdate PUT /v4/api/message/{id}
MessageDeliveryStatusApi messageDeliveryStatusCreate POST /v4/api/message-delivery-status
MessageDeliveryStatusApi messageDeliveryStatusDelete DELETE /v4/api/message-delivery-status/{id}
MessageDeliveryStatusApi messageDeliveryStatusGet GET /v4/api/message-delivery-status/{id}
MessageDeliveryStatusApi messageDeliveryStatusSearch GET /v4/api/message-delivery-status
MessageDeliveryStatusApi messageDeliveryStatusUpdate PUT /v4/api/message-delivery-status/{id}
MessageTemplateApi messageTemplateCreate POST /v4/api/message-template
MessageTemplateApi messageTemplateDelete DELETE /v4/api/message-template/{id}
MessageTemplateApi messageTemplateGet GET /v4/api/message-template/{id}
MessageTemplateApi messageTemplateSearch GET /v4/api/message-template
MessageTemplateApi messageTemplateUpdate PUT /v4/api/message-template/{id}
MessageTemplateAssignmentApi messageTemplateAssignmentCreate POST /v4/api/message-template-assignment
MessageTemplateAssignmentApi messageTemplateAssignmentDelete DELETE /v4/api/message-template-assignment/{id}
MessageTemplateAssignmentApi messageTemplateAssignmentGet GET /v4/api/message-template-assignment/{id}
MessageTemplateAssignmentApi messageTemplateAssignmentSearch GET /v4/api/message-template-assignment
MessageTemplateAssignmentApi messageTemplateAssignmentUpdate PUT /v4/api/message-template-assignment/{id}
NotepadApi notepadCreate POST /v4/api/notepad
NotepadApi notepadGet GET /v4/api/notepad/{id}
NotepadApi notepadSearch GET /v4/api/notepad
NotepadApi notepadUpdate PUT /v4/api/notepad/{id}
NotificationLogApi notificationLogCreate POST /v4/api/notification-log
NotificationLogApi notificationLogDelete DELETE /v4/api/notification-log/{id}
NotificationLogApi notificationLogGet GET /v4/api/notification-log/{id}
NotificationLogApi notificationLogSearch GET /v4/api/notification-log
RcsAgentApi rcsAgentCreate POST /v4/api/rcs-agent
RcsAgentApi rcsAgentDelete DELETE /v4/api/rcs-agent/{id}
RcsAgentApi rcsAgentGet GET /v4/api/rcs-agent/{id}
RcsAgentApi rcsAgentSearch GET /v4/api/rcs-agent
RcsAgentApi rcsAgentUpdate PUT /v4/api/rcs-agent/{id}
RcsAgentBusinessApi rcsAgentBusinessCreate POST /v4/api/rcs-agent-business
RcsAgentBusinessApi rcsAgentBusinessDelete DELETE /v4/api/rcs-agent-business/{id}
RcsAgentBusinessApi rcsAgentBusinessGet GET /v4/api/rcs-agent-business/{id}
RcsAgentBusinessApi rcsAgentBusinessSearch GET /v4/api/rcs-agent-business
RcsAgentBusinessApi rcsAgentBusinessUpdate PUT /v4/api/rcs-agent-business/{id}
RcsAgentMetadataApi rcsAgentMetadataCreate POST /v4/api/rcs-agent-metadata
RcsAgentMetadataApi rcsAgentMetadataDelete DELETE /v4/api/rcs-agent-metadata/{id}
RcsAgentMetadataApi rcsAgentMetadataGet GET /v4/api/rcs-agent-metadata/{id}
RcsAgentMetadataApi rcsAgentMetadataSearch GET /v4/api/rcs-agent-metadata
RcsAgentMetadataApi rcsAgentMetadataUpdate PUT /v4/api/rcs-agent-metadata/{id}
RcsAgentUseCaseApi rcsAgentUseCaseCreate POST /v4/api/rcs-agent-use-case
RcsAgentUseCaseApi rcsAgentUseCaseDelete DELETE /v4/api/rcs-agent-use-case/{id}
RcsAgentUseCaseApi rcsAgentUseCaseGet GET /v4/api/rcs-agent-use-case/{id}
RcsAgentUseCaseApi rcsAgentUseCaseSearch GET /v4/api/rcs-agent-use-case
RcsAgentUseCaseApi rcsAgentUseCaseUpdate PUT /v4/api/rcs-agent-use-case/{id}
RegionApi regionCreate POST /v4/api/region
RegionApi regionDelete DELETE /v4/api/region/{id}
RegionApi regionGet GET /v4/api/region/{id}
RegionApi regionSearch GET /v4/api/region
RegionApi regionUpdate PUT /v4/api/region/{id}
SmsActivityApi smsActivityCreate POST /v4/api/sms-activity
SmsActivityApi smsActivityDelete DELETE /v4/api/sms-activity/{id}
SmsActivityApi smsActivityGet GET /v4/api/sms-activity/{id}
SmsActivityApi smsActivitySearch GET /v4/api/sms-activity
SmsActivityApi smsActivityUpdate PUT /v4/api/sms-activity/{id}
TaskApi taskCreate POST /v4/api/task
TaskApi taskDelete DELETE /v4/api/task/{id}
TaskApi taskGet GET /v4/api/task/{id}
TaskApi taskSearch GET /v4/api/task
TaskApi taskUpdate PUT /v4/api/task/{id}
TeamApi teamCreate POST /v4/api/team
TeamApi teamDelete DELETE /v4/api/team/{id}
TeamApi teamGet GET /v4/api/team/{id}
TeamApi teamSearch GET /v4/api/team
TeamApi teamUpdate PUT /v4/api/team/{id}
TimelineApi timelineCreate POST /v4/api/timeline
TimelineApi timelineDelete DELETE /v4/api/timeline/{id}
TimelineApi timelineGet GET /v4/api/timeline/{id}
TimelineApi timelineSearch GET /v4/api/timeline
TimelineApi timelineUpdate PUT /v4/api/timeline/{id}
UserApi userCreate POST /v4/api/user
UserApi userDelete DELETE /v4/api/user/{id}
UserApi userGet GET /v4/api/user/{id}
UserApi userSearch GET /v4/api/user
UserApi userUpdate PUT /v4/api/user/{id}
UserExternalIdApi userExternalIdCreate POST /v4/api/user-external-id
UserExternalIdApi userExternalIdDelete DELETE /v4/api/user-external-id/{id}
UserExternalIdApi userExternalIdGet GET /v4/api/user-external-id/{id}
UserExternalIdApi userExternalIdSearch GET /v4/api/user-external-id
UserExternalIdApi userExternalIdUpdate PUT /v4/api/user-external-id/{id}
UserMetadataApi userMetadataCreate POST /v4/api/user-metadata
UserMetadataApi userMetadataDelete DELETE /v4/api/user-metadata/{id}
UserMetadataApi userMetadataGet GET /v4/api/user-metadata/{id}
UserMetadataApi userMetadataSearch GET /v4/api/user-metadata
UserMetadataApi userMetadataUpdate PUT /v4/api/user-metadata/{id}
UserTeamApi userTeamCreate POST /v4/api/user-team
UserTeamApi userTeamDelete DELETE /v4/api/user-team/{team}/{user}
VendorMessageApi vendorMessageCreate POST /v4/api/vendor-message
VendorMessageApi vendorMessageGet GET /v4/api/vendor-message/{id}
VendorMessageApi vendorMessageSearch GET /v4/api/vendor-message
WidgetApi getV4ApiWidgetsCampaigns GET /v4/api/widgets/campaigns/{accountId}
WidgetApi widgetCreate POST /v4/api/widget
WidgetApi widgetDelete DELETE /v4/api/widget/{id}
WidgetApi widgetGet GET /v4/api/widget/{id}
WidgetApi widgetSearch GET /v4/api/widget
WidgetApi widgetUpdate PUT /v4/api/widget/{id}
WidgetMetadataApi widgetMetadataCreate POST /v4/api/widget-metadata
WidgetMetadataApi widgetMetadataDelete DELETE /v4/api/widget-metadata/{id}
WidgetMetadataApi widgetMetadataGet GET /v4/api/widget-metadata/{id}
WidgetMetadataApi widgetMetadataSearch GET /v4/api/widget-metadata
WidgetMetadataApi widgetMetadataUpdate PUT /v4/api/widget-metadata/{id}

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

Bearer

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author