Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mikepsinn committed Sep 5, 2018
1 parent 812d43d commit 0c94f32
Showing 1 changed file with 102 additions and 47 deletions.
149 changes: 102 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ We make it easy to retrieve and analyze normalized user data from a wide array o

This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 5.8.100414
- Package version: 5.8.1119
- API version: 5.8.112511
- Build package: io.swagger.codegen.languages.PhpClientCodegen

## Requirements

PHP 5.4.0 and later
PHP 5.5 and later

## Installation & Usage
### Composer
Expand Down Expand Up @@ -84,13 +83,11 @@ All URIs are relative to *https://app.quantimo.do/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AnalyticsApi* | [**deleteVote**](docs/Api/AnalyticsApi.md#deletevote) | **DELETE** /v3/votes/delete | Delete vote
*AnalyticsApi* | [**getAggregatedCorrelations**](docs/Api/AnalyticsApi.md#getaggregatedcorrelations) | **GET** /v3/aggregatedCorrelations | Get aggregated correlations
*AnalyticsApi* | [**getStudy**](docs/Api/AnalyticsApi.md#getstudy) | **GET** /v4/study | Get Study
*AnalyticsApi* | [**getUserCorrelationExplanations**](docs/Api/AnalyticsApi.md#getusercorrelationexplanations) | **GET** /v3/correlations/explanations | Get correlation explanations
*AnalyticsApi* | [**getUserCorrelations**](docs/Api/AnalyticsApi.md#getusercorrelations) | **GET** /v3/correlations | Get correlations
*AnalyticsApi* | [**postAggregatedCorrelations**](docs/Api/AnalyticsApi.md#postaggregatedcorrelations) | **POST** /v3/aggregatedCorrelations | Store or Update a Correlation
*AnalyticsApi* | [**postVote**](docs/Api/AnalyticsApi.md#postvote) | **POST** /v3/votes | Post or update vote
*ActivitiesApi* | [**getActivities**](docs/Api/ActivitiesApi.md#getactivities) | **GET** /v3/activities | Get Activities
*ActivitiesApi* | [**postActivities**](docs/Api/ActivitiesApi.md#postactivities) | **POST** /v3/activities | Post Activities
*AnalyticsApi* | [**getCorrelationExplanations**](docs/Api/AnalyticsApi.md#getcorrelationexplanations) | **GET** /v3/correlations/explanations | Get correlation explanations
*AnalyticsApi* | [**getCorrelations**](docs/Api/AnalyticsApi.md#getcorrelations) | **GET** /v3/correlations | Get correlations
*AppSettingsApi* | [**getAppSettings**](docs/Api/AppSettingsApi.md#getappsettings) | **GET** /v3/appSettings | Get client app settings
*AuthenticationApi* | [**getAccessToken**](docs/Api/AuthenticationApi.md#getaccesstoken) | **GET** /v3/oauth2/token | Get a user access token
*AuthenticationApi* | [**getOauthAuthorizationCode**](docs/Api/AuthenticationApi.md#getoauthauthorizationcode) | **GET** /v3/oauth2/authorize | Request Authorization Code
*AuthenticationApi* | [**postGoogleIdToken**](docs/Api/AuthenticationApi.md#postgoogleidtoken) | **POST** /v3/googleIdToken | Post GoogleIdToken
Expand All @@ -100,104 +97,162 @@ Class | Method | HTTP request | Description
*ConnectorsApi* | [**getIntegrationJs**](docs/Api/ConnectorsApi.md#getintegrationjs) | **GET** /v3/integration.js | Get embeddable connect javascript
*ConnectorsApi* | [**getMobileConnectPage**](docs/Api/ConnectorsApi.md#getmobileconnectpage) | **GET** /v3/connect/mobile | Mobile connect page
*ConnectorsApi* | [**updateConnector**](docs/Api/ConnectorsApi.md#updateconnector) | **GET** /v3/connectors/{connectorName}/update | Sync with data source
*FeedApi* | [**getFeed**](docs/Api/FeedApi.md#getfeed) | **GET** /v3/feed | Tracking reminder notifications, messages, and study results
*FeedApi* | [**postFeed**](docs/Api/FeedApi.md#postfeed) | **POST** /v3/feed | Post user interactions with feed
*FriendsApi* | [**getFriends**](docs/Api/FriendsApi.md#getfriends) | **GET** /v3/friends | Get Friends
*FriendsApi* | [**postFriends**](docs/Api/FriendsApi.md#postfriends) | **POST** /v3/friends | Post Friends
*GroupsApi* | [**getGroups**](docs/Api/GroupsApi.md#getgroups) | **GET** /v3/groups | Get Groups
*GroupsApi* | [**getGroupsMembers**](docs/Api/GroupsApi.md#getgroupsmembers) | **GET** /v3/groupsMembers | Get GroupsMembers
*GroupsApi* | [**postGroups**](docs/Api/GroupsApi.md#postgroups) | **POST** /v3/groups | Post Groups
*GroupsApi* | [**postGroupsMembers**](docs/Api/GroupsApi.md#postgroupsmembers) | **POST** /v3/groupsMembers | Post GroupsMembers
*MeasurementsApi* | [**deleteMeasurement**](docs/Api/MeasurementsApi.md#deletemeasurement) | **DELETE** /v3/measurements/delete | Delete a measurement
*MeasurementsApi* | [**getMeasurements**](docs/Api/MeasurementsApi.md#getmeasurements) | **GET** /v3/measurements | Get measurements for this user
*MeasurementsApi* | [**getPairs**](docs/Api/MeasurementsApi.md#getpairs) | **GET** /v3/pairs | Get pairs of measurements for correlational analysis
*MeasurementsApi* | [**measurementExportRequest**](docs/Api/MeasurementsApi.md#measurementexportrequest) | **POST** /v2/measurements/exportRequest | Post Request for Measurements CSV
*MeasurementsApi* | [**postMeasurements**](docs/Api/MeasurementsApi.md#postmeasurements) | **POST** /v3/measurements/post | Post a new set or update existing measurements to the database
*MeasurementsApi* | [**v3MeasurementsUpdatePost**](docs/Api/MeasurementsApi.md#v3measurementsupdatepost) | **POST** /v3/measurements/update | Update a measurement
*MeasurementsApi* | [**updateMeasurement**](docs/Api/MeasurementsApi.md#updatemeasurement) | **POST** /v3/measurements/update | Update a measurement
*MessagesApi* | [**getMessagesMessages**](docs/Api/MessagesApi.md#getmessagesmessages) | **GET** /v3/messagesMessages | Get MessagesMessages
*MessagesApi* | [**getMessagesNotices**](docs/Api/MessagesApi.md#getmessagesnotices) | **GET** /v3/messagesNotices | Get MessagesNotices
*MessagesApi* | [**getMessagesRecipients**](docs/Api/MessagesApi.md#getmessagesrecipients) | **GET** /v3/messagesRecipients | Get MessagesRecipients
*MessagesApi* | [**postMessagesMessages**](docs/Api/MessagesApi.md#postmessagesmessages) | **POST** /v3/messagesMessages | Post MessagesMessages
*MessagesApi* | [**postMessagesNotices**](docs/Api/MessagesApi.md#postmessagesnotices) | **POST** /v3/messagesNotices | Post MessagesNotices
*MessagesApi* | [**postMessagesRecipients**](docs/Api/MessagesApi.md#postmessagesrecipients) | **POST** /v3/messagesRecipients | Post MessagesRecipients
*NotificationsApi* | [**getNotificationPreferences**](docs/Api/NotificationsApi.md#getnotificationpreferences) | **GET** /v3/notificationPreferences | Get NotificationPreferences
*NotificationsApi* | [**postDeviceTokens**](docs/Api/NotificationsApi.md#postdevicetokens) | **POST** /v3/deviceTokens | Post DeviceTokens
*RemindersApi* | [**deleteTrackingReminder**](docs/Api/RemindersApi.md#deletetrackingreminder) | **DELETE** /v3/trackingReminders/delete | Delete tracking reminder
*NotificationsApi* | [**getNotifications**](docs/Api/NotificationsApi.md#getnotifications) | **GET** /v3/notifications | Get Notifications
*NotificationsApi* | [**postDeviceToken**](docs/Api/NotificationsApi.md#postdevicetoken) | **POST** /v3/deviceTokens | Post DeviceTokens
*NotificationsApi* | [**postNotifications**](docs/Api/NotificationsApi.md#postnotifications) | **POST** /v3/notifications | Post Notifications
*RemindersApi* | [**deleteTrackingReminder**](docs/Api/RemindersApi.md#deletetrackingreminder) | **DELETE** /v3/trackingReminders/delete | Delete Tracking Reminder
*RemindersApi* | [**getTrackingReminderNotifications**](docs/Api/RemindersApi.md#gettrackingremindernotifications) | **GET** /v3/trackingReminderNotifications | Get specific tracking reminder notifications
*RemindersApi* | [**getTrackingReminders**](docs/Api/RemindersApi.md#gettrackingreminders) | **GET** /v3/trackingReminders | Get repeating tracking reminder settings
*RemindersApi* | [**postTrackingReminderNotifications**](docs/Api/RemindersApi.md#posttrackingremindernotifications) | **POST** /v3/trackingReminderNotifications | Snooze, skip, or track a tracking reminder notification
*RemindersApi* | [**postTrackingReminders**](docs/Api/RemindersApi.md#posttrackingreminders) | **POST** /v3/trackingReminders | Store a Tracking Reminder
*StudyApi* | [**postStudyPublish**](docs/Api/StudyApi.md#poststudypublish) | **POST** /v3/study/publish | Post Study Publish
*SharesApi* | [**deleteShare**](docs/Api/SharesApi.md#deleteshare) | **POST** /v3/shares/delete | Delete share
*SharesApi* | [**getShares**](docs/Api/SharesApi.md#getshares) | **GET** /v3/shares | Get Authorized Apps, Studies, and Individuals
*SharesApi* | [**inviteShare**](docs/Api/SharesApi.md#inviteshare) | **POST** /v3/shares/invite | Delete share
*StudiesApi* | [**createStudy**](docs/Api/StudiesApi.md#createstudy) | **POST** /v3/study/create | Create a Study
*StudiesApi* | [**deleteVote**](docs/Api/StudiesApi.md#deletevote) | **DELETE** /v3/votes/delete | Delete vote
*StudiesApi* | [**getOpenStudies**](docs/Api/StudiesApi.md#getopenstudies) | **GET** /v3/studies/open | These are open studies that anyone can join
*StudiesApi* | [**getStudies**](docs/Api/StudiesApi.md#getstudies) | **GET** /v3/studies | Get Personal or Population Studies
*StudiesApi* | [**getStudiesCreated**](docs/Api/StudiesApi.md#getstudiescreated) | **GET** /v3/studies/created | Get studies you have created
*StudiesApi* | [**getStudiesJoined**](docs/Api/StudiesApi.md#getstudiesjoined) | **GET** /v3/studies/joined | Studies You Have Joined
*StudiesApi* | [**getStudy**](docs/Api/StudiesApi.md#getstudy) | **GET** /v4/study | Get Study
*StudiesApi* | [**joinStudy**](docs/Api/StudiesApi.md#joinstudy) | **POST** /v3/study/join | Join a Study
*StudiesApi* | [**postVote**](docs/Api/StudiesApi.md#postvote) | **POST** /v3/votes | Post or update vote
*StudiesApi* | [**publishStudy**](docs/Api/StudiesApi.md#publishstudy) | **POST** /v3/study/publish | Publish Your Study
*UnitsApi* | [**getUnitCategories**](docs/Api/UnitsApi.md#getunitcategories) | **GET** /v3/unitCategories | Get unit categories
*UnitsApi* | [**getUnits**](docs/Api/UnitsApi.md#getunits) | **GET** /v3/units | Get units
*UserApi* | [**deleteUser**](docs/Api/UserApi.md#deleteuser) | **DELETE** /v3/user/delete | Delete user
*UserApi* | [**getUser**](docs/Api/UserApi.md#getuser) | **GET** /v3/user | Get user info
*UserApi* | [**getUserBlogs**](docs/Api/UserApi.md#getuserblogs) | **GET** /v3/userBlogs | Get UserBlogs
*UserApi* | [**postUserBlogs**](docs/Api/UserApi.md#postuserblogs) | **POST** /v3/userBlogs | Post UserBlogs
*UserApi* | [**postUserSettings**](docs/Api/UserApi.md#postusersettings) | **POST** /v3/userSettings | Post UserSettings
*VariablesApi* | [**deleteUserTag**](docs/Api/VariablesApi.md#deleteusertag) | **DELETE** /v3/userTags/delete | Delete user tag or ingredient
*VariablesApi* | [**deleteUserVariable**](docs/Api/VariablesApi.md#deleteuservariable) | **DELETE** /v3/userVariables/delete | Delete All Measurements For Variable
*VariablesApi* | [**getCommonVariables**](docs/Api/VariablesApi.md#getcommonvariables) | **GET** /v3/public/variables | Get common variables with aggregated instead of user-specific data
*VariablesApi* | [**getUserVariables**](docs/Api/VariablesApi.md#getuservariables) | **GET** /v3/userVariables | Get variables along with related user-specific analysis settings and statistics
*VariablesApi* | [**getVariableCategories**](docs/Api/VariablesApi.md#getvariablecategories) | **GET** /v3/variableCategories | Variable categories
*VariablesApi* | [**getVariables**](docs/Api/VariablesApi.md#getvariables) | **GET** /v3/variables | Get variables along with related user-specific analysis settings and statistics
*VariablesApi* | [**postUserTags**](docs/Api/VariablesApi.md#postusertags) | **POST** /v3/userTags | Post or update user tags or ingredients
*VariablesApi* | [**postUserVariables**](docs/Api/VariablesApi.md#postuservariables) | **POST** /v3/userVariables | Update User Settings for a Variable
*VariablesApi* | [**postUserVariables**](docs/Api/VariablesApi.md#postuservariables) | **POST** /v3/variables | Update User Settings for a Variable
*VariablesApi* | [**resetUserVariableSettings**](docs/Api/VariablesApi.md#resetuservariablesettings) | **POST** /v3/userVariables/reset | Reset user settings for a variable to defaults
*XprofileApi* | [**getXprofileData**](docs/Api/XprofileApi.md#getxprofiledata) | **GET** /v3/xprofileData | Get XprofileData
*XprofileApi* | [**getXprofileFields**](docs/Api/XprofileApi.md#getxprofilefields) | **GET** /v3/xprofileFields | Get XprofileFields
*XprofileApi* | [**getXprofileGroups**](docs/Api/XprofileApi.md#getxprofilegroups) | **GET** /v3/xprofileGroups | Get XprofileGroups
*XprofileApi* | [**postXprofileData**](docs/Api/XprofileApi.md#postxprofiledata) | **POST** /v3/xprofileData | Post XprofileData
*XprofileApi* | [**postXprofileFields**](docs/Api/XprofileApi.md#postxprofilefields) | **POST** /v3/xprofileFields | Post XprofileFields
*XprofileApi* | [**postXprofileGroups**](docs/Api/XprofileApi.md#postxprofilegroups) | **POST** /v3/xprofileGroups | Post XprofileGroups


## Documentation For Models

- [ActivitiesResponse](docs/Model/ActivitiesResponse.md)
- [Activity](docs/Model/Activity.md)
- [AppSettings](docs/Model/AppSettings.md)
- [AppSettingsResponse](docs/Model/AppSettingsResponse.md)
- [AuthorizedClients](docs/Model/AuthorizedClients.md)
- [Button](docs/Model/Button.md)
- [Card](docs/Model/Card.md)
- [Chart](docs/Model/Chart.md)
- [ChartStyle](docs/Model/ChartStyle.md)
- [Column](docs/Model/Column.md)
- [CommonResponse](docs/Model/CommonResponse.md)
- [CommonVariable](docs/Model/CommonVariable.md)
- [CommonVariableArray](docs/Model/CommonVariableArray.md)
- [Connector](docs/Model/Connector.md)
- [ConnectInstructions](docs/Model/ConnectInstructions.md)
- [ConversionStep](docs/Model/ConversionStep.md)
- [Correlation](docs/Model/Correlation.md)
- [DataSource](docs/Model/DataSource.md)
- [DeviceToken](docs/Model/DeviceToken.md)
- [Explanation](docs/Model/Explanation.md)
- [ExplanationStartTracking](docs/Model/ExplanationStartTracking.md)
- [FeedResponse](docs/Model/FeedResponse.md)
- [Friend](docs/Model/Friend.md)
- [FriendsResponse](docs/Model/FriendsResponse.md)
- [GetConnectorsResponse](docs/Model/GetConnectorsResponse.md)
- [GetCorrelationsDataResponse](docs/Model/GetCorrelationsDataResponse.md)
- [GetCorrelationsResponse](docs/Model/GetCorrelationsResponse.md)
- [GetStudyDataResponse](docs/Model/GetStudyDataResponse.md)
- [GetStudyResponse](docs/Model/GetStudyResponse.md)
- [GetSharesResponse](docs/Model/GetSharesResponse.md)
- [GetStudiesResponse](docs/Model/GetStudiesResponse.md)
- [GetTrackingReminderNotificationsResponse](docs/Model/GetTrackingReminderNotificationsResponse.md)
- [Hover](docs/Model/Hover.md)
- [Group](docs/Model/Group.md)
- [GroupsMember](docs/Model/GroupsMember.md)
- [GroupsMembersResponse](docs/Model/GroupsMembersResponse.md)
- [GroupsResponse](docs/Model/GroupsResponse.md)
- [Image](docs/Model/Image.md)
- [InputField](docs/Model/InputField.md)
- [JsonErrorResponse](docs/Model/JsonErrorResponse.md)
- [Marker](docs/Model/Marker.md)
- [Measurement](docs/Model/Measurement.md)
- [MeasurementArray](docs/Model/MeasurementArray.md)
- [MeasurementDelete](docs/Model/MeasurementDelete.md)
- [MeasurementItem](docs/Model/MeasurementItem.md)
- [MeasurementSet](docs/Model/MeasurementSet.md)
- [MeasurementUpdate](docs/Model/MeasurementUpdate.md)
- [MessagesMessage](docs/Model/MessagesMessage.md)
- [MessagesMessagesResponse](docs/Model/MessagesMessagesResponse.md)
- [MessagesNotice](docs/Model/MessagesNotice.md)
- [MessagesNoticesResponse](docs/Model/MessagesNoticesResponse.md)
- [MessagesRecipient](docs/Model/MessagesRecipient.md)
- [MessagesRecipientsResponse](docs/Model/MessagesRecipientsResponse.md)
- [Notification](docs/Model/Notification.md)
- [NotificationsResponse](docs/Model/NotificationsResponse.md)
- [Pair](docs/Model/Pair.md)
- [PairArray](docs/Model/PairArray.md)
- [PairsOfAveragesForAllUser](docs/Model/PairsOfAveragesForAllUser.md)
- [ParticipantInstruction](docs/Model/ParticipantInstruction.md)
- [PostCorrelation](docs/Model/PostCorrelation.md)
- [PostMeasurementsDataResponse](docs/Model/PostMeasurementsDataResponse.md)
- [PostMeasurementsResponse](docs/Model/PostMeasurementsResponse.md)
- [PostStudyCreateResponse](docs/Model/PostStudyCreateResponse.md)
- [PostStudyPublishResponse](docs/Model/PostStudyPublishResponse.md)
- [PostTrackingRemindersDataResponse](docs/Model/PostTrackingRemindersDataResponse.md)
- [PostTrackingRemindersResponse](docs/Model/PostTrackingRemindersResponse.md)
- [PostUserSettingsDataResponse](docs/Model/PostUserSettingsDataResponse.md)
- [PostUserSettingsResponse](docs/Model/PostUserSettingsResponse.md)
- [ProcessedDailyMeasurement](docs/Model/ProcessedDailyMeasurement.md)
- [Scope](docs/Model/Scope.md)
- [Series](docs/Model/Series.md)
- [State](docs/Model/State.md)
- [Text](docs/Model/Text.md)
- [Title](docs/Model/Title.md)
- [Tooltip](docs/Model/Tooltip.md)
- [ShareInvitationBody](docs/Model/ShareInvitationBody.md)
- [Study](docs/Model/Study.md)
- [StudyCharts](docs/Model/StudyCharts.md)
- [StudyCreationBody](docs/Model/StudyCreationBody.md)
- [StudyHtml](docs/Model/StudyHtml.md)
- [StudyImages](docs/Model/StudyImages.md)
- [StudyJoinResponse](docs/Model/StudyJoinResponse.md)
- [StudyLinks](docs/Model/StudyLinks.md)
- [StudySharing](docs/Model/StudySharing.md)
- [StudyText](docs/Model/StudyText.md)
- [StudyVotes](docs/Model/StudyVotes.md)
- [TrackingReminder](docs/Model/TrackingReminder.md)
- [TrackingReminderArray](docs/Model/TrackingReminderArray.md)
- [TrackingReminderDelete](docs/Model/TrackingReminderDelete.md)
- [TrackingReminderNotification](docs/Model/TrackingReminderNotification.md)
- [TrackingReminderNotificationActionArray](docs/Model/TrackingReminderNotificationActionArray.md)
- [TrackingReminderNotificationAction](docs/Model/TrackingReminderNotificationAction.md)
- [TrackingReminderNotificationPost](docs/Model/TrackingReminderNotificationPost.md)
- [TrackingReminderNotificationTrackAllAction](docs/Model/TrackingReminderNotificationTrackAllAction.md)
- [TrackingReminderNotificationsArray](docs/Model/TrackingReminderNotificationsArray.md)
- [Unit](docs/Model/Unit.md)
- [UnitCategory](docs/Model/UnitCategory.md)
- [User](docs/Model/User.md)
- [UserStudy](docs/Model/UserStudy.md)
- [UserBlog](docs/Model/UserBlog.md)
- [UserBlogsResponse](docs/Model/UserBlogsResponse.md)
- [UserTag](docs/Model/UserTag.md)
- [UserVariable](docs/Model/UserVariable.md)
- [UserVariableArray](docs/Model/UserVariableArray.md)
- [UserVariableDelete](docs/Model/UserVariableDelete.md)
- [Variable](docs/Model/Variable.md)
- [VariableCategory](docs/Model/VariableCategory.md)
- [VariableCharts](docs/Model/VariableCharts.md)
- [Vote](docs/Model/Vote.md)
- [VoteDelete](docs/Model/VoteDelete.md)
- [XAxi](docs/Model/XAxi.md)
- [XprofileDataResponse](docs/Model/XprofileDataResponse.md)
- [XprofileDatum](docs/Model/XprofileDatum.md)
- [XprofileField](docs/Model/XprofileField.md)
- [XprofileFieldsResponse](docs/Model/XprofileFieldsResponse.md)
- [XprofileGroup](docs/Model/XprofileGroup.md)
- [XprofileGroupsResponse](docs/Model/XprofileGroupsResponse.md)


## Documentation For Authorization
Expand All @@ -221,9 +276,9 @@ Class | Method | HTTP request | Description
- **Flow**: accessCode
- **Authorization URL**: https://app.quantimo.do/api/v2/oauth/authorize
- **Scopes**:
- **basic**: Allows you to read user info (display name, email, etc).
- **readmeasurements**: Allows one to read a user's data
- **writemeasurements**: Allows you to write user data
- **basic**: Allows you to read user info (display name, email, etc)
- **readmeasurements**: Allows one to read a user's measurements
- **writemeasurements**: Allows you to write user measurements


## Author
Expand Down

0 comments on commit 0c94f32

Please sign in to comment.