squadlist-api-swagger-client

Squadlist

• API version: 1.0.0
  • Build date: 2021-04-06T09:59:33.441+01:00

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

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 this dependency to your project's POM:

<dependency>
  <groupId>uk.co.squadlist</groupId>
  <artifactId>squadlist-api-swagger-client</artifactId>
  <version>2021040601</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "uk.co.squadlist:squadlist-api-swagger-client:2021040601"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/squadlist-api-swagger-client-2021040601.jar
• target/lib/*.jar

Getting Started

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

import uk.co.squadlist.client.swagger.*;
import uk.co.squadlist.client.swagger.auth.*;
import uk.co.squadlist.model.swagger.*;
import uk.co.squadlist.client.swagger.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            List<Change> result = apiInstance.changeLogGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#changeLogGet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.squadlist.app

Class	Method	HTTP request	Description
DefaultApi	changeLogGet	GET /change-log
DefaultApi	instancesGet	GET /instances
DefaultApi	instancesIdGet	GET /instances/{id}
DefaultApi	instancesInstanceBoatsGet	GET /instances/{instance}/boats
DefaultApi	instancesInstanceBoatsIdGet	GET /instances/{instance}/boats/{id}
DefaultApi	instancesInstanceMembersGet	GET /instances/{instance}/members
DefaultApi	instancesInstanceStatisticsGet	GET /instances/{instance}/statistics
DefaultApi	membersIdGet	GET /members/{id}
DefaultApi	outingsGet	GET /outings	Outings
DefaultApi	outingsIdAvailabilityGet	GET /outings/{id}/availability
DefaultApi	outingsIdGet	GET /outings/{id}	Outing
DefaultApi	outingsMonthsGet	GET /outings/months	Outings months
DefaultApi	passwordSuggestionsGet	GET /password-suggestions
DefaultApi	squadsGet	GET /squads
DefaultApi	squadsIdGet	GET /squads/{id}
DefaultApi	subscriptionRequestsGet	GET /subscription-requests
DefaultApi	subscriptionRequestsIdGet	GET /subscription-requests/{id}
DefaultApi	subscriptionRequestsIdPut	PUT /subscription-requests/{id}
DefaultApi	subscriptionRequestsPost	POST /subscription-requests
DefaultApi	tariffsGet	GET /tariffs
DefaultApi	verifyPost	POST /verify

Documentation for Models

• Availability
• AvailabilityOption
• Boat
• Change
• Instance
• Member
• OAuthError
• Outing
• Squad
• Statistics
• Subscription
• SubscriptionRequest
• SubscriptionRequestSubmission
• Tariff

Documentation for Authorization

Authentication schemes defined for the API:

api

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Recommendation

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

Author