Skip to content

UsersEssentials.md

Latest commit

 

History

History
65 lines (49 loc) · 2.73 KB

UsersEssentials.md

File metadata and controls

65 lines (49 loc) · 2.73 KB
Raw

UsersEssentials — operations

Accessor: client.UsersEssentials · Source: src/VimeoApi/Api/UsersEssentials.cs · 4 operations

Type sources: the file declaring each type an operation names (RawError excluded — see sdk-map.md).

EditUser

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: EditUser(EditUserRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: UserId
  • Returns: User
  • Error: ApiException<EditUserError> — Case A (typed)
  • Error accessors: TryGetError(out Error) [400] · TryGetRawError(out RawError) [fallback]
Type Source
EditUserRequest src/VimeoApi/Requests/UsersEssentials/EditUserRequest.cs
UsersRequest src/VimeoApi/Models/UsersRequest.cs
User src/VimeoApi/Models/User.cs
EditUserError src/VimeoApi/Errors/EditUserError.cs
Error src/VimeoApi/Models/Error.cs

EditUserAlt1

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: EditUserAlt1(EditUserAlt1Request request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
  • Returns: User
  • Error: ApiException<EditUserAlt1Error> — Case A (typed)
  • Error accessors: TryGetError(out Error) [400] · TryGetRawError(out RawError) [fallback]
Type Source
EditUserAlt1Request src/VimeoApi/Requests/UsersEssentials/EditUserAlt1Request.cs
MeRequest src/VimeoApi/Models/MeRequest.cs
User src/VimeoApi/Models/User.cs
EditUserAlt1Error src/VimeoApi/Errors/EditUserAlt1Error.cs
Error src/VimeoApi/Models/Error.cs

GetUser

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: GetUser(GetUserRequest request, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
    • required: UserId
  • Returns: User
  • Error: ApiException<RawError> — Case B
Type Source
GetUserRequest src/VimeoApi/Requests/UsersEssentials/GetUserRequest.cs
User src/VimeoApi/Models/User.cs

GetUserAlt1

  • Auth: options.Oauth2AuthorizationCode OR options.Oauth2ClientCredentials OR options.Bearer
  • Signature: GetUserAlt1(RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
  • Returns: User
  • Error: ApiException<RawError> — Case B
Type Source
User src/VimeoApi/Models/User.cs