Swift5 API client for OpenAPIClient

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: 0.1.0
• Package version:
• Build package: org.openapitools.codegen.languages.Swift5ClientCodegen

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

Documentation for API Endpoints

All URIs are relative to https://finchapp.eastus.cloudapp.azure.com/api

Class	Method	HTTP request	Description
AssetClassesAPI	getAssetClasses	GET /asset_classes	Gets list of asset classes
EventAPI	getEventExamples	GET /event/examples	Get example events
GoalAPI	deleteGoal	DELETE /goal/{id}	Delete one specific goal by id
GoalAPI	getGoal	GET /goal/{id}	Get one specific goal by id
GoalAPI	getGoalExamples	GET /goal/examples	Get example Goals
GoalAPI	getGoals	GET /goals	Get all of a user's goals
GoalAPI	newGoal	POST /goal/new	Creates a new goal for the user
GoalAPI	updateGoal	PUT /goal/{id}	Update one specific goal by id
InsightsAPI	dismissInsight	PUT /insight/{id}/dismiss	Dismiss an insight
InsightsAPI	getInsightExamples	GET /insights/examples	Get example insights
InsightsAPI	getInsights	GET /insights	Get all a user's (non-dismissed) insights
LeaderboardAPI	getLeaderboard	GET /leaderboard/{type}	Get a leaderboard
PlaidAPI	deleteAccount	DELETE /plaid/accounts/{id}	Delete account with given item_id
PlaidAPI	getAccounts	GET /plaid/accounts/{allOrUnhidden}	Get all of user's connected accounts
PlaidAPI	plaidLink	POST /plaid/link_token	to request link token for PlaidLink
PlaidAPI	plaidLinkAccess	POST /plaid/public_token_exchange	For after a user does PlaidLink thru client
PlaidAPI	setAccountAsHidden	PUT /plaid/accounts/hide	Hides or unhides an account
PlanAPI	deletePlan	DELETE /plan	Delete user's plan
PlanAPI	getPlaidPlan	GET /plan/plaid	Get plaid plan and generate timeseries for 365 days
PlanAPI	getPlaidPlanWithDays	GET /plan/plaid/{days}	Get plaid plan and generate timeseries for specified number of days
PlanAPI	getPlan	GET /plan	Get plan and generate timeseries for 365 days
PlanAPI	getPlanWithDays	GET /plan/{days}	Get plan and generate timeseries for specified number of days
PlanAPI	newPlan	POST /plan	Creates a new plan for the user and generate timeseries for 365 days
PlanAPI	newPlanWithDays	POST /plan/{days}	Creates a new plan for the user and generate timeseries for specified number of days
PlanAPI	updatePlan	PUT /plan	Update plan and generate timeseries for 365 days
PlanAPI	updatePlanWithDays	PUT /plan/{days}	Update plan and generate timeseries for specified number of days
RecurringAPI	deleteRecurring	DELETE /recurring/{id}	Delete one specific recurring by id
RecurringAPI	getRecurring	GET /recurring/{id}	Get one specific recurring by id
RecurringAPI	getRecurringExamples	GET /recurring/examples	Get example Recurrings
RecurringAPI	getRecurrings	GET /recurrings	Get all of a user's recurrings
RecurringAPI	newRecurring	POST /recurring/new	Creates a new recurring for the user
RecurringAPI	updateRecurring	PUT /recurring/{id}	Update one specific recurring by id
SnapshotsAPI	getSnapshots	GET /snapshots	Get all a user's snapshots
TimeseriesAPI	getTimeseries	GET /timeseries/{days}	Get a user's projection timeseries
TimeseriesAPI	getTimeseriesExample	GET /timeseries/example	Get an example timeseries
TimeseriesAPI	getTimeseriesYear	GET /timeseries	Get timeseries with 365 future days generated
UserAPI	getUser	GET /user	Gets user info
UserAPI	loginUser	POST /login	Log in a user
UserAPI	logoutUser	POST /logout	Log out a user
UserAPI	signupUser	POST /signup	Sign up a user
UsersAPI	registerIOSDevice	POST /registerIOSDevice	This route will be called once a user logs in on an iOS device and route body will contain the URL of the iOS device, this will be stored in the User model.
UsersAPI	updateUser	PUT /update/user	This route receives a payload with requests to change data of a user
ValidationAPI	validateUser	POST /validate/user	This route lets our clients perform step-by-step signups.

Documentation For Models

• Account
• AccountError
• AccountsResponse
• Allocation
• AllocationProportion
• ApiError
• Asset
• AssetClass
• AssetClassAndApy
• AssetClassChange
• BoardType
• Event
• Goal
• GoalAndStatus
• GoalMetric
• GoalNewPayload
• Insight
• ItemIdResponse
• KnownFinancialProduct
• LinkTokenCreateResponse
• Location
• LoginPayload
• Money
• MongoObjectID
• PlaidJWT
• Plan
• PlanNewPayload
• PlanResponse
• PlanUpdatePayload
• PublicTokenExchangeRequest
• Ranking
• Recurring
• RecurringNewPayload
• SetAccountAsHiddenPayload
• SignupPayload
• Snapshot
• TimeInterval
• TimePeriod
• TimeSeriesEntry
• TimeSeriesResponse
• UpdateUserRequest
• User
• ValidateUserPayload

Documentation For Authorization

sidCookie

• Type: API key
• API key parameter name: finch-sid
• Location:

Author