NAME

Imgur::API::Endpoint::Account

DESCRIPTION

Access to the imgur Account API Endpoint. 

See: https://api.imgur.com/endpoints/account

METHODS

get

Request standard user information. If you need the username for the account that is logged in, it is returned in the request for an access token. Note: This endpoint also supports the ability to lookup account base info by account ID. To do so, pass the query parameter account_id.

Parameters

username required
```
Username
```

galleryFavorites

Return the images the user has favorited in the gallery.

Parameters

username required
```
Username
```

page optional

integer - allows you to set the page number so you don't have to retrieve all the data at once.

sort optional

'oldest', or 'newest'. Defaults to 'newest'.

favorites

Returns the users favorited images, only accessible if you're logged in as the user.

Parameters

sort optional

'oldest', or 'newest'. Defaults to 'newest'.

page optional

integer - allows you to set the page number so you don't have to retrieve all the data at once.

username required
```
Username
```

submissions

Return the images a user has submitted to the gallery

Parameters

page required
```
Page
```
username required
```
Username
```

settings

Returns the account settings, only accessible if you're logged in as the user.

Parameters

username required
```
Username
```

updateSettings

Updates the account settings for a given user, the user must be logged in.

Parameters

accepted_gallery_terms optional

true | false - The user agreement to the Imgur Gallery terms.

messaging_enabled optional

true | false - Allows the user to enable / disable private messages

show_mature optional

true | false - Toggle display of mature images in gallery list endpoints.

album_privacy optional

public | hidden | secret - Sets the default privacy level of albums the users creates

username optional

A valid Imgur username (between 4 and 63 alphanumeric characters)

newsletter_subscribed optional

true | false - Toggle subscription to email newsletter.

public_images optional

Set the users images to private or public by default

bio optional

The biography of the user, is displayed in the gallery profile page.

profile

Returns the totals for the gallery profile.

Parameters

username required
```
Username
```

verifyEmail

Checks to see if user has verified their email address

Parameters

username required
```
Username
```

sendVerifyEmail

Sends an email to the user to verify that their email is valid to upload to gallery. Must be logged in as the user to send.

Parameters

username required
```
Username
```

albums

Get all the albums associated with the account. Must be logged in as the user to see secret and hidden albums.

Parameters

username required
```
Username
```

page optional

integer - allows you to set the page number so you don't have to retrieve all the data at once.

album

Get additional information about an album, this endpoint works the same as the Album Endpoint. You can also use any of the additional routes that are used on an album in the album endpoint.

Parameters

username required
```
Username
```
account required
```
Account
```

albumIds

Return an array of all of the album IDs.

Parameters

username required
```
Username
```

page optional

integer - allows you to set the page number so you don't have to retrieve all the data at once.

albumCount

Return the total number of albums associated with the account.

Parameters

username required
```
Username
```

albumDelete

Delete an Album with a given id.

Parameters

username required
```
Username
```
account required
```
Account
```

comments

Return the comments the user has created.

Parameters

sort optional

'best', 'worst', 'oldest', or 'newest'. Defaults to 'newest'.

username required
```
Username
```

page optional

Page number (50 items per page). Defaults to 0.

comment

Return information about a specific comment. This endpoint works the same as the Comment Endpoint. You can use any of the additional actions that the comment endpoint allows on this end point.

Parameters

username required
```
Username
```
account required
```
Account
```

commentIds

Return an array of all of the comment IDs.

Parameters

username required
```
Username
```

page optional

Page number (50 items per page). Defaults to 0.

sort optional

'best', 'worst', 'oldest', or 'newest'. Defaults to 'newest'.

commentCount

Return a count of all of the comments associated with the account.

Parameters

username required
```
Username
```

commentDelete

Delete a comment. You are required to be logged in as the user whom created the comment.

Parameters

account required
```
Account
```
username required
```
Username
```

images

Return all of the images associated with the account. You can page through the images by setting the page, this defaults to 0.

Parameters

page required
```
Page
```
username required
```
Username
```

image

Return information about a specific image. This endpoint works the same as the Image Endpoint. You can use any of the additional actions that the image endpoint with this endpoint.

Parameters

username required
```
Username
```
account required
```
Account
```

imageIds

Returns an array of Image IDs that are associated with the account.

Parameters

username required
```
Username
```

page optional

integer - allows you to set the page number so you don't have to retrieve all the data at once.

imageCount

Returns the total number of images associated with the account.

Parameters

username required
```
Username
```

imageDelete

Deletes an Image. This requires a delete hash rather than an ID.

Parameters

username required
```
Username
```
deletehash required
```
Deletehash
```

replies

Returns all of the reply notifications for the user. Required to be logged in as that user

Parameters

new optional

boolean - false for all notifications, true for only non-viewed notification. Default is true.

username required
```
Username
```

49 POD Errors

The following errors were encountered while parsing the POD:

Around line 21: