openapi-android-client

Requirements

Building the API client library requires Maven to be installed.

Installation

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

mvn install

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

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>org.openapitools</groupId>
    <artifactId>openapi-android-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.openapitools:openapi-android-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/openapi-android-client-1.0.0.jar
• target/lib/*.jar

Getting Started

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

import org.openapitools.client.api.AccountApi;

public class AccountApiExample {

    public static void main(String[] args) {
        AccountApi apiInstance = new AccountApi();
        String body = "body_example"; // String | 
        try {
            apiInstance.accountPasswordCheckTokenPost(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountApi#accountPasswordCheckTokenPost");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://http:/v1

Class	Method	HTTP request	Description
AccountApi	accountPasswordCheckTokenPost	POST /account/password/check-token	Validate password reset token
AccountApi	accountPasswordForgotPost	POST /account/password/forgot	Request password reset link
AccountApi	accountPasswordResetPost	POST /account/password/reset	Reset a forgotten password with a token
AdminApi	adminFreePassDelete	DELETE /admin/free-pass	Revokes an existing free pass
AdminApi	adminFreePassPut	PUT /admin/free-pass	Creates a free pass to an article
AdminApi	adminFreePassesGet	GET /admin/free-passes	Lists all free passes
AdminApi	adminSearchPost	POST /admin/search	Search for users
AdminApi	adminTransferPassiveSubscribersListidPost	POST /admin/transfer-passive-subscribers/{listid}	Transfers passive customers from Kayak to Mailchimp
AdminApi	adminUserPost	POST /admin/user	Create a new user with admin options.
AdminApi	adminUserUuidDelete	DELETE /admin/user/{uuid}	Delete user
EntitlementsApi	entitlementsAllowDelete	DELETE /entitlements/allow	Remove an entitlement
EntitlementsApi	entitlementsAllowGet	GET /entitlements/allow	Check if global entitlements are enabled
EntitlementsApi	entitlementsAllowPost	POST /entitlements/allow	Add an entitlement for all users
EntitlementsApi	entitlementsAllowUuidPost	POST /entitlements/allow/{uuid}	Grant product access to a customer
EntitlementsApi	entitlementsFreePassGet	GET /entitlements/free-pass	Verify given free pass hash
EntitlementsApi	entitlementsGet	GET /entitlements	List all entitlements
EntitlementsApi	entitlementsGlobalGet	GET /entitlements/global	Lists all past and future global entitlements
IdentificationApi	identificationLoginGet	GET /identification/login	Authenticate with OpenID Connect
IdentificationApi	identificationLoginMonitorGet	GET /identification/login/monitor	Get token for off band response login flow monitor
IdentificationApi	identificationLoginReturnGet	GET /identification/login/return	Redirect endpoint for OpenID Connect
IdentificationApi	identificationUserStampUuidPost	POST /identification/user/stamp/{uuid}	Query when the strong identification was last updated
LoginApi	loginIpGet	GET /login/ip	Login with IP
LoginApi	loginPost	POST /login	Login with email and password
LoginApi	loginSsoPost	POST /login/sso	Disabled. Always returns 403.
LoginApi	loginUuidDelete	DELETE /login/{uuid}	Logout
UsersApi	usersPost	POST /users	Create a new user.
UsersApi	usersTemporaryPost	POST /users/temporary	Create a new user with email.
UsersApi	usersUuidEntitlementGet	GET /users/{uuid}/entitlement	Get users entitlements.
UsersApi	usersUuidGdprPut	PUT /users/{uuid}/gdpr	Updates the GDPR consent settings for a given user.
UsersApi	usersUuidGet	GET /users/{uuid}	Get user by UUID.
UsersApi	usersUuidLegalPut	PUT /users/{uuid}/legal	Updates the legal consent settings for a given user.
UsersApi	usersUuidNewslettersGet	GET /users/{uuid}/newsletters	Get newsletter subscriptions
UsersApi	usersUuidNewslettersPut	PUT /users/{uuid}/newsletters	Update newsletter subscriptions
UsersApi	usersUuidPasswordPut	PUT /users/{uuid}/password	Set / Change user password
UsersApi	usersUuidPatch	PATCH /users/{uuid}	Update a user
UsersApi	usersUuidPaymentsGet	GET /users/{uuid}/payments	Get user's subscriptions and payment events
UsersApi	usersUuidScopeGet	GET /users/{uuid}/scope	Check if user has valid token for a scope
UsersApi	usersUuidSubscriptionsSubsnoAddressChangeDelete	DELETE /users/{uuid}/subscriptions/{subsno}/addressChange	Delete temporary address change for subscription
UsersApi	usersUuidSubscriptionsSubsnoAddressChangePatch	PATCH /users/{uuid}/subscriptions/{subsno}/addressChange	Edit temporary address change dates of a subscription
UsersApi	usersUuidSubscriptionsSubsnoAddressChangePost	POST /users/{uuid}/subscriptions/{subsno}/addressChange	Make a temporary address change for a subscription
UsersApi	usersUuidSubscriptionsSubsnoCancelPut	PUT /users/{uuid}/subscriptions/{subsno}/cancel	Cancels user subscription
UsersApi	usersUuidSubscriptionsSubsnoPausePatch	PATCH /users/{uuid}/subscriptions/{subsno}/pause	Edit pause duration
UsersApi	usersUuidSubscriptionsSubsnoPausePost	POST /users/{uuid}/subscriptions/{subsno}/pause	Pause users subscription
UsersApi	usersUuidSubscriptionsSubsnoReclamationPost	POST /users/{uuid}/subscriptions/{subsno}/reclamation	Create a new delivery reclamation for a subscription
UsersApi	usersUuidSubscriptionsSubsnoReclamationsReclaimnoGet	GET /users/{uuid}/subscriptions/{subsno}/reclamations/{reclaimno}	Get a delivery reclamation
UsersApi	usersUuidSubscriptionsSubsnoUnpausePost	POST /users/{uuid}/subscriptions/{subsno}/unpause	Unpause users subscription

Documentation for Models

• ActiveDays
• Address
• AdminNewUser
• CancelSubscriptionReason
• DeleteTempAddressChangeDates
• DeliveryAddress
• DeliveryReclamation
• EntitlementAccess
• FaroUser
• ForgotPasswordData
• FreePass
• FreePassInput
• GdprConsent
• InlineResponse400
• InlineResponse400InvalidRequestBody
• InlineResponse403
• InlineResponse4031
• InlineResponse4031AccessTokenExpired
• InlineResponse403InvalidCredentials
• InlineResponse415
• InlineResponse415UnsupportedMediaType
• InlineResponse500
• InlineResponse500InternalServerError
• JanrainUser
• LegalConsent
• LoginData
• LoginDataSSO
• LoginResponse
• ModelPackage
• NewDeliveryReclamation
• NewTemporaryUser
• NewUser
• Newsletter
• NewsletterSubscription
• PackageCampaign
• PackageOffer
• Paper
• PastTemporaryAddress
• PausedSubscription
• Payment
• PendingAddressChange
• PersistedEntitlementAccess
• Product
• SearchQuery
• SearchResult
• Subscription
• SubscriptionDates
• SubscriptionPauseDates
• SubscriptionPauseEdit
• SubscriptionPayments
• TemporaryAddressChange
• TemporaryAddressChangeDates
• UpdatePasswordData
• User
• UserUpdate
• UserUpdateAddress
• UserUpdatePassword

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

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

Author