Package jp.gopay.sdk.resources

Interface WebhooksResource

public interface WebhooksResource

Resources for managing webhooks associated with the merchant's stores.

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Webhook>	create(StoreId storeId, WebhookReq dataToPost, IdempotencyKey idempotencyKey)
retrofit2.Call<Webhook>	create(WebhookReq dataToPost, IdempotencyKey idempotencyKey)
retrofit2.Call<Void>	delete(StoreId storeId, WebhookId webhookId)
retrofit2.Call<Void>	delete(WebhookId webhookId)
retrofit2.Call<Webhook>	get(StoreId storeId, WebhookId webhookId)
retrofit2.Call<Webhook>	get(WebhookId webhookId)
retrofit2.Call<PaginatedList<Webhook>>	list(Integer limit, CursorDirection cursorDirection, WebhookId cursor)
retrofit2.Call<PaginatedList<Webhook>>	list(StoreId storeId, Integer limit, CursorDirection cursorDirection, WebhookId cursor)
retrofit2.Call<Webhook>	update(StoreId storeId, WebhookId webhookId, WebhookReq dataToPost, IdempotencyKey idempotencyKey)
retrofit2.Call<Webhook>	update(WebhookId webhookId, WebhookReq dataToPost, IdempotencyKey idempotencyKey)

Method Detail

list

@GET("/webhooks")
retrofit2.Call<PaginatedList<Webhook>> list(@Query("limit") @Nullable
                                            Integer limit,
                                            @Query("cursor_direction") @Nullable
                                            CursorDirection cursorDirection,
                                            @Query("cursor") @Nullable
                                            WebhookId cursor)

get

@GET("/webhooks/{webhookId}")
retrofit2.Call<Webhook> get(@Path("webhookId")
                            WebhookId webhookId)

create

@POST("/webhooks")
retrofit2.Call<Webhook> create(@Body
                               WebhookReq dataToPost,
                               @Header("Idempotency-Key")
                               IdempotencyKey idempotencyKey)

update

@PATCH("/webhooks/{webhookId}")
retrofit2.Call<Webhook> update(@Path("webhookId")
                               WebhookId webhookId,
                               @Body
                               WebhookReq dataToPost,
                               @Header("Idempotency-Key")
                               IdempotencyKey idempotencyKey)

delete

@DELETE("/webhooks/{webhookId}")
retrofit2.Call<Void> delete(@Path("webhookId")
                            WebhookId webhookId)

list

@GET("/stores/{storeId}/webhooks")
retrofit2.Call<PaginatedList<Webhook>> list(@Path("storeId")
                                            StoreId storeId,
                                            @Query("limit") @Nullable
                                            Integer limit,
                                            @Query("cursor_direction") @Nullable
                                            CursorDirection cursorDirection,
                                            @Query("cursor") @Nullable
                                            WebhookId cursor)

create

@POST("/stores/{storeId}/webhooks")
retrofit2.Call<Webhook> create(@Path("storeId")
                               StoreId storeId,
                               @Body
                               WebhookReq dataToPost,
                               @Header("Idempotency-Key")
                               IdempotencyKey idempotencyKey)

get

@GET("/stores/{storeId}/webhooks/{webhookId}")
retrofit2.Call<Webhook> get(@Path("storeId")
                            StoreId storeId,
                            @Path("webhookId")
                            WebhookId webhookId)

update

@PATCH("/stores/{storeId}/webhooks/{webhookId}")
retrofit2.Call<Webhook> update(@Path("storeId")
                               StoreId storeId,
                               @Path("webhookId")
                               WebhookId webhookId,
                               @Body
                               WebhookReq dataToPost,
                               @Header("Idempotency-Key")
                               IdempotencyKey idempotencyKey)

delete

@DELETE("/stores/{storeId}/webhooks/{webhookId}")
retrofit2.Call<Void> delete(@Path("storeId")
                            StoreId storeId,
                            @Path("webhookId")
                            WebhookId webhookId)