com.mangopay.core.APIs

Interface HookApi

All Known Implementing Classes:

HookApiImpl

public interface HookApi

Created by thepa on 18-Jan-17.

Method Summary

Modifier and Type	Method and Description
Hook	create(Hook hook) Creates new hook.
Hook	create(java.lang.String idempotencyKey, Hook hook) Creates new hook.
Hook	get(java.lang.String hookId) Gets hook.
java.util.List<Hook>	getAll() Gets all hooks.
java.util.List<Hook>	getAll(Pagination pagination, Sorting sorting) Gets all hooks.
Hook	update(Hook hook) Saves hook.

Method Detail

create

Hook create(Hook hook)
     throws java.lang.Exception

Creates new hook.

Parameters:

hook - Hook instance to be created.

Returns:

Hook instance returned from API.

Throws:

java.lang.Exception

create

Hook create(java.lang.String idempotencyKey,
            Hook hook)
     throws java.lang.Exception

Creates new hook.

Parameters:

idempotencyKey - idempotency key for this request.

hook - Hook instance to be created.

Returns:

Hook instance returned from API.

Throws:

java.lang.Exception

get

Hook get(java.lang.String hookId)
  throws java.lang.Exception

Gets hook.

Parameters:

hookId - Hook identifier.

Returns:

Hook instance returned from API.

Throws:

java.lang.Exception

update

Hook update(Hook hook)
     throws java.lang.Exception

Saves hook.

Parameters:

hook - Hook instance to be saved.

Returns:

Hook instance returned from API.

Throws:

java.lang.Exception

getAll

java.util.List<Hook> getAll(Pagination pagination,
                            Sorting sorting)
                     throws java.lang.Exception

Gets all hooks.

Parameters:

pagination - Pagination.

Returns:

List of Hook instances returned from API.

Throws:

java.lang.Exception

getAll

java.util.List<Hook> getAll()
                     throws java.lang.Exception

Gets all hooks.

Returns:

List of Hook instances returned from API.

Throws:

java.lang.Exception