Package com.stripe.service.v2.iam

Class ApiKeyService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.v2.iam.ApiKeyService

public final class ApiKeyService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
ApiKeyService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
ApiKey	create(ApiKeyCreateParams params)	Create an API key.
ApiKey	create(ApiKeyCreateParams params, RequestOptions options)	Create an API key.
ApiKey	expire(String id)	Expire an API key.
ApiKey	expire(String id, RequestOptions options)	Expire an API key.
StripeCollection<ApiKey>	list()	List all API keys of an account.
StripeCollection<ApiKey>	list(RequestOptions options)	List all API keys of an account.
StripeCollection<ApiKey>	list(ApiKeyListParams params)	List all API keys of an account.
StripeCollection<ApiKey>	list(ApiKeyListParams params, RequestOptions options)	List all API keys of an account.
ApiKey	retrieve(String id)	Retrieve an API key.
ApiKey	retrieve(String id, RequestOptions options)	Retrieve an API key.
ApiKey	rotate(String id)	Rotate an API key.
ApiKey	rotate(String id, RequestOptions options)	Rotate an API key.
ApiKey	rotate(String id, ApiKeyRotateParams params)	Rotate an API key.
ApiKey	rotate(String id, ApiKeyRotateParams params, RequestOptions options)	Rotate an API key.
ApiKey	update(String id)	Update an API key.
ApiKey	update(String id, RequestOptions options)	Update an API key.
ApiKey	update(String id, ApiKeyUpdateParams params)	Update an API key.
ApiKey	update(String id, ApiKeyUpdateParams params, RequestOptions options)	Update an API key.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

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

Constructor Details

ApiKeyService

public ApiKeyService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<ApiKey> list(ApiKeyListParams params)
                              throws StripeException

List all API keys of an account.

Throws:

StripeException

list

public StripeCollection<ApiKey> list(RequestOptions options)
                              throws StripeException

List all API keys of an account.

Throws:

StripeException

list

public StripeCollection<ApiKey> list()
                              throws StripeException

List all API keys of an account.

Throws:

StripeException

list

public StripeCollection<ApiKey> list(ApiKeyListParams params,
 RequestOptions options)
                              throws StripeException

List all API keys of an account.

Throws:

StripeException

create

public ApiKey create(ApiKeyCreateParams params)
              throws StripeException

Create an API key. To create a secret key in livemode, a public key for encryption must be provided.

Throws:

StripeException

create

public ApiKey create(ApiKeyCreateParams params,
 RequestOptions options)
              throws StripeException

Create an API key. To create a secret key in livemode, a public key for encryption must be provided.

Throws:

StripeException

retrieve

public ApiKey retrieve(String id)
                throws StripeException

Retrieve an API key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.

Throws:

StripeException

retrieve

public ApiKey retrieve(String id,
 RequestOptions options)
                throws StripeException

Retrieve an API key. For livemode secret keys, secret tokens are only returned on creation, and never returned here.

Throws:

StripeException

update

public ApiKey update(String id,
 ApiKeyUpdateParams params)
              throws StripeException

Update an API key. Only parameters that are specified in the request will be updated.

Throws:

StripeException

update

public ApiKey update(String id,
 RequestOptions options)
              throws StripeException

Update an API key. Only parameters that are specified in the request will be updated.

Throws:

StripeException

update

public ApiKey update(String id)
              throws StripeException

Update an API key. Only parameters that are specified in the request will be updated.

Throws:

StripeException

update

public ApiKey update(String id,
 ApiKeyUpdateParams params,
 RequestOptions options)
              throws StripeException

Update an API key. Only parameters that are specified in the request will be updated.

Throws:

StripeException

expire

public ApiKey expire(String id)
              throws StripeException

Expire an API key. The specified key becomes invalid immediately.

Throws:

StripeException

expire

public ApiKey expire(String id,
 RequestOptions options)
              throws StripeException

Expire an API key. The specified key becomes invalid immediately.

Throws:

StripeException

rotate

public ApiKey rotate(String id,
 ApiKeyRotateParams params)
              throws StripeException

Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.

Throws:

StripeException

rotate

public ApiKey rotate(String id,
 RequestOptions options)
              throws StripeException

Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.

Throws:

StripeException

rotate

public ApiKey rotate(String id)
              throws StripeException

Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.

Throws:

StripeException

rotate

public ApiKey rotate(String id,
 ApiKeyRotateParams params,
 RequestOptions options)
              throws StripeException

Rotate an API key. A new key with the same properties is created and returned. The existing key is expired immediately, unless an expiry time is specified.

Throws:

StripeException