docs/me.md in losant_rest-1.8.7 vs docs/me.md in losant_rest-1.8.9

- old
+ new

@@ -15,10 +15,11 @@ * [Enable Two Factor Auth](#enable-two-factor-auth) * [Fetch Recent Items](#fetch-recent-items) * [Get](#get) * [Patch](#patch) * [Payload Counts](#payload-counts) +* [Refresh Token](#refresh-token) * [Transfer Resources](#transfer-resources) * [Verify Email](#verify-email) <br/> @@ -33,11 +34,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.addRecentItem. +all.User, me.*, or me.addRecentItem. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -69,11 +70,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.changePassword. +all.User, me.*, or me.changePassword. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -105,11 +106,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.delete. +all.User, me.*, or me.delete. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -141,11 +142,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.disableTwoFactorAuth. +all.User, me.*, or me.disableTwoFactorAuth. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -177,11 +178,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.disconnectGithub. +all.User, me.*, or me.disconnectGithub. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -212,11 +213,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.disconnectTwitter. +all.User, me.*, or me.disconnectTwitter. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -247,11 +248,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.enableTwoFactorAuth. +all.User, me.*, or me.enableTwoFactorAuth. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -283,11 +284,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.fetchRecentItems. +all.User, all.User.read, me.*, or me.fetchRecentItems. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -320,11 +321,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.get. +all.User, all.User.read, me.*, or me.get. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -357,11 +358,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.patch. +all.User, me.*, or me.patch. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -395,11 +396,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, all.User.read, me.*, or me.payloadCounts. +all.User, all.User.read, me.*, or me.payloadCounts. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -419,10 +420,46 @@ | ---- | ---- | ----------- | | 400 | [Error](_schemas.md#error) | Error if malformed request | <br/> +## Refresh Token + +Returns a new auth token based on the current auth token + +```ruby +result = client.me.refresh_token(optional_params) + +puts result +``` + +#### Authentication +The client must be configured with a valid api access token to call this +action. The token must include at least one of the following scopes: +all.User, or me.*. + +#### Available Parameters + +| Name | Type | Required | Description | Default | Example | +| ---- | ---- | -------- | ----------- | ------- | ------- | +| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | + +#### Successful Responses + +| Code | Type | Description | +| ---- | ---- | ----------- | +| 200 | [Authenticated User](_schemas.md#authenticated-user) | Successful token regeneration | + +#### Error Responses + +| Code | Type | Description | +| ---- | ---- | ----------- | +| 400 | [Error](_schemas.md#error) | Error if malformed request | +| 401 | [Error](_schemas.md#error) | Unauthorized error if authentication fails | + +<br/> + ## Transfer Resources Moves resources to a new owner ```ruby @@ -432,11 +469,11 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.transferResources. +all.User, me.*, or me.transferResources. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- | @@ -468,10 +505,10 @@ ``` #### Authentication The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: -all.SolutionUser, all.User, me.*, or me.verifyEmail. +all.User, me.*, or me.verifyEmail. #### Available Parameters | Name | Type | Required | Description | Default | Example | | ---- | ---- | -------- | ----------- | ------- | ------- |