NAME
Imgur::API::Endpoint::AccountSYNOPSISA
Access to the imgur Account API Endpoint.
See: https://api.imgur.com/endpoints/accountMETHODS
get(%params)
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 =over 4
username REQUIRED Username
galleryFavorites(%params)
Return the images the user has favorited in the gallery.Parameters =over 4
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
favorites(%params)
Returns the users favorited images, only accessible if you're logged in as the user.Parameters =over 4
username REQUIRED Username
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.
submissions(%params)
Return the images a user has submitted to the galleryParameters =over 4
username REQUIRED Username
page REQUIRED Page
settings(%params)
Returns the account settings, only accessible if you're logged in as the user.Parameters =over 4
username REQUIRED Username
updateSettings(%params)
Updates the account settings for a given user, the user must be logged in.Parameters =over 4
public_images OPTIONAL Set the users images to private or public by default
accepted_gallery_terms OPTIONAL true | false - The user agreement to the Imgur Gallery terms.
username OPTIONAL A valid Imgur username (between 4 and 63 alphanumeric characters)
newsletter_subscribed OPTIONAL true | false - Toggle subscription to email newsletter.
messaging_enabled OPTIONAL true | false - Allows the user to enable / disable private messages
album_privacy OPTIONAL public | hidden | secret - Sets the default privacy level of albums the users creates
bio OPTIONAL The biography of the user, is displayed in the gallery profile page.
show_mature OPTIONAL true | false - Toggle display of mature images in gallery list endpoints.
profile(%params)
Returns the totals for the gallery profile.Parameters =over 4
username REQUIRED Username
verifyEmail(%params)
Checks to see if user has verified their email addressParameters =over 4
username REQUIRED Username
sendVerifyEmail(%params)
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 =over 4
username REQUIRED Username
albums(%params)
Get all the albums associated with the account. Must be logged in as the user to see secret and hidden albums. Parameters =over 4
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(%params)
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 =over 4
username REQUIRED Username
account REQUIRED Account
albumIds(%params)
Return an array of all of the album IDs.Parameters =over 4
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(%params)
Return the total number of albums associated with the account.Parameters =over 4
username REQUIRED Username
albumDelete(%params)
Delete an Album with a given id.Parameters =over 4
username REQUIRED Username
account REQUIRED Account
comments(%params)
Return the comments the user has created.Parameters =over 4
username REQUIRED Username
page OPTIONAL Page number (50 items per page). Defaults to 0.
sort OPTIONAL 'best', 'worst', 'oldest', or 'newest'. Defaults to 'newest'.
comment(%params)
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 =over 4
username REQUIRED Username
account REQUIRED Account
commentIds(%params)
Return an array of all of the comment IDs.Parameters =over 4
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(%params)
Return a count of all of the comments associated with the account.Parameters =over 4
username REQUIRED Username
commentDelete(%params)
Delete a comment. You are required to be logged in as the user whom created the comment.Parameters =over 4
account REQUIRED Account
username REQUIRED Username
images(%params)
Return all of the images associated with the account. You can page through the images by setting the page, this defaults to 0. Parameters =over 4
username REQUIRED Username
page REQUIRED Page
image(%params)
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 =over 4
account REQUIRED Account
username REQUIRED Username
imageIds(%params)
Returns an array of Image IDs that are associated with the account. Parameters =over 4
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
imageCount(%params)
Returns the total number of images associated with the account. Parameters =over 4
username REQUIRED Username
imageDelete(%params)
Deletes an Image. This requires a delete hash rather than an ID.Parameters =over 4
deletehash REQUIRED Deletehash
username REQUIRED Username
replies(%params)
Returns all of the reply notifications for the user. Required to be logged in as that userParameters =over 4
new OPTIONAL boolean - false for all notifications, true for only non-viewed notification. Default is true.
username REQUIRED Username
25 POD Errors
The following errors were encountered while parsing the POD:
- Around line 22:
'=item' outside of any '=over'
- Around line 36:
'=item' outside of any '=over'
- Around line 58:
'=item' outside of any '=over'
- Around line 80:
'=item' outside of any '=over'
- Around line 98:
'=item' outside of any '=over'
- Around line 112:
'=item' outside of any '=over'
- Around line 154:
'=item' outside of any '=over'
- Around line 168:
'=item' outside of any '=over'
- Around line 182:
'=item' outside of any '=over'
- Around line 196:
'=item' outside of any '=over'
- Around line 214:
'=item' outside of any '=over'
- Around line 232:
'=item' outside of any '=over'
- Around line 250:
'=item' outside of any '=over'
- Around line 264:
'=item' outside of any '=over'
- Around line 282:
'=item' outside of any '=over'
- Around line 304:
'=item' outside of any '=over'
- Around line 322:
'=item' outside of any '=over'
- Around line 344:
'=item' outside of any '=over'
- Around line 358:
'=item' outside of any '=over'
- Around line 376:
'=item' outside of any '=over'
- Around line 394:
'=item' outside of any '=over'
- Around line 412:
'=item' outside of any '=over'
- Around line 430:
'=item' outside of any '=over'
- Around line 444:
'=item' outside of any '=over'
- Around line 462:
'=item' outside of any '=over'