com.mangopay.core.APIs.implementation

Class HookApiImpl

java.lang.Object

com.mangopay.core.APIs.ApiBase

com.mangopay.core.APIs.implementation.HookApiImpl

All Implemented Interfaces:

HookApi

public class HookApiImpl
extends ApiBase
implements HookApi

API for hooks.

Field Summary

Fields inherited from class com.mangopay.core.APIs.ApiBase

root

Constructor Summary

Constructors

Constructor and Description
HookApiImpl(MangoPayApi root) Instantiates new HookApiImpl object.

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.

Methods inherited from class com.mangopay.core.APIs.ApiBase

createObject, createObject, createObject, getList, getList, getList, getList, getList, getList, getListNoClientId, getObject, getObjectNoClientId, getRequestType, getRequestUrl, getRoot, updateObject, updateObject, updateObject, updateObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HookApiImpl

public HookApiImpl(MangoPayApi root)

Instantiates new HookApiImpl object.

Parameters:

root - Root/parent instance that holds the OAuthToken and Configuration instance.

Method Detail

create

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

Description copied from interface: HookApi

Creates new hook.

Specified by:

create in interface HookApi

Parameters:

hook - Hook instance to be created.

Returns:

Hook instance returned from API.

Throws:

java.lang.Exception

create

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

Description copied from interface: HookApi

Creates new hook.

Specified by:

create in interface HookApi

Parameters:

idempotencyKey - idempotency key for this request.

hook - Hook instance to be created.

Returns:

Hook instance returned from API.

Throws:

java.lang.Exception

get

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

Description copied from interface: HookApi

Gets hook.

Specified by:

get in interface HookApi

Parameters:

hookId - Hook identifier.

Returns:

Hook instance returned from API.

Throws:

java.lang.Exception

update

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

Description copied from interface: HookApi

Saves hook.

Specified by:

update in interface HookApi

Parameters:

hook - Hook instance to be saved.

Returns:

Hook instance returned from API.

Throws:

java.lang.Exception

getAll

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

Description copied from interface: HookApi

Gets all hooks.

Specified by:

getAll in interface HookApi

Parameters:

pagination - Pagination.

Returns:

List of Hook instances returned from API.

Throws:

java.lang.Exception

getAll

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

Description copied from interface: HookApi

Gets all hooks.

Specified by:

getAll in interface HookApi

Returns:

List of Hook instances returned from API.

Throws:

java.lang.Exception