Package com.stripe.service.apps

Class InstallService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.apps.InstallService

public final class InstallService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
InstallService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
Install	create(InstallCreateParams params)	Creates an app install.
Install	create(InstallCreateParams params, RequestOptions options)	Creates an app install.
StripeCollection<Install>	list()	Returns a list of app installs.
StripeCollection<Install>	list(RequestOptions options)	Returns a list of app installs.
StripeCollection<Install>	list(InstallListParams params)	Returns a list of app installs.
StripeCollection<Install>	list(InstallListParams params, RequestOptions options)	Returns a list of app installs.
Install	retrieve(String id)	Retrieves an app install.
Install	retrieve(String id, RequestOptions options)	Retrieves an app install.
Install	retrieve(String id, InstallRetrieveParams params)	Retrieves an app install.
Install	retrieve(String id, InstallRetrieveParams params, RequestOptions options)	Retrieves an app install.
Install	uninstall(String id)	Uninstalls an app from the account that installed it.
Install	uninstall(String id, RequestOptions options)	Uninstalls an app from the account that installed it.
Install	uninstall(String id, InstallUninstallParams params)	Uninstalls an app from the account that installed it.
Install	uninstall(String id, InstallUninstallParams params, RequestOptions options)	Uninstalls an app from the account that installed it.
Install	update(String id)	Reauthorizes an app install.
Install	update(String id, RequestOptions options)	Reauthorizes an app install.
Install	update(String id, InstallUpdateParams params)	Reauthorizes an app install.
Install	update(String id, InstallUpdateParams params, RequestOptions options)	Reauthorizes an app install.

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

InstallService

public InstallService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<Install> list(InstallListParams params)
                               throws StripeException

Returns a list of app installs. An app developer or embedding platform filtering by its own app sees the installs across the accounts that installed it; other callers see the installs on their own account. The key selects the environment: a live key lists live installs, a sandbox API key lists the installs on that sandbox, and the key of an app’s managed sandbox filtering by app lists that app’s installs across every sandbox. For existing accounts that still use legacy test mode, a test mode key lists legacy test mode installs.

Throws:

StripeException

list

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

Returns a list of app installs. An app developer or embedding platform filtering by its own app sees the installs across the accounts that installed it; other callers see the installs on their own account. The key selects the environment: a live key lists live installs, a sandbox API key lists the installs on that sandbox, and the key of an app’s managed sandbox filtering by app lists that app’s installs across every sandbox. For existing accounts that still use legacy test mode, a test mode key lists legacy test mode installs.

Throws:

StripeException

list

public StripeCollection<Install> list()
                               throws StripeException

Returns a list of app installs. An app developer or embedding platform filtering by its own app sees the installs across the accounts that installed it; other callers see the installs on their own account. The key selects the environment: a live key lists live installs, a sandbox API key lists the installs on that sandbox, and the key of an app’s managed sandbox filtering by app lists that app’s installs across every sandbox. For existing accounts that still use legacy test mode, a test mode key lists legacy test mode installs.

Throws:

StripeException

list

public StripeCollection<Install> list(InstallListParams params,
 RequestOptions options)
                               throws StripeException

Returns a list of app installs. An app developer or embedding platform filtering by its own app sees the installs across the accounts that installed it; other callers see the installs on their own account. The key selects the environment: a live key lists live installs, a sandbox API key lists the installs on that sandbox, and the key of an app’s managed sandbox filtering by app lists that app’s installs across every sandbox. For existing accounts that still use legacy test mode, a test mode key lists legacy test mode installs.

Throws:

StripeException

create

public Install create(InstallCreateParams params)
               throws StripeException

Creates an app install. An account installs its own private app with its own key; public and testing installs are made from the Dashboard. An app developer or embedding platform acting on a connected account through Stripe-Account installs or reinstalls its app there. For a private app, creating an install installs the newest completed upload; when that version is already installed with nothing pending, the existing install is returned.

Throws:

StripeException

create

public Install create(InstallCreateParams params,
 RequestOptions options)
               throws StripeException

Creates an app install. An account installs its own private app with its own key; public and testing installs are made from the Dashboard. An app developer or embedding platform acting on a connected account through Stripe-Account installs or reinstalls its app there. For a private app, creating an install installs the newest completed upload; when that version is already installed with nothing pending, the existing install is returned.

Throws:

StripeException

retrieve

public Install retrieve(String id,
 InstallRetrieveParams params)
                 throws StripeException

Retrieves an app install. The installing account, the app’s developer (with the keys of the account that owns the app or of the app’s managed sandbox), and the embedding platform that created the install can retrieve it.

Throws:

StripeException

retrieve

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

Retrieves an app install. The installing account, the app’s developer (with the keys of the account that owns the app or of the app’s managed sandbox), and the embedding platform that created the install can retrieve it.

Throws:

StripeException

retrieve

public Install retrieve(String id)
                 throws StripeException

Retrieves an app install. The installing account, the app’s developer (with the keys of the account that owns the app or of the app’s managed sandbox), and the embedding platform that created the install can retrieve it.

Throws:

StripeException

retrieve

public Install retrieve(String id,
 InstallRetrieveParams params,
 RequestOptions options)
                 throws StripeException

Retrieves an app install. The installing account, the app’s developer (with the keys of the account that owns the app or of the app’s managed sandbox), and the embedding platform that created the install can retrieve it.

Throws:

StripeException

update

public Install update(String id,
 InstallUpdateParams params)
               throws StripeException

Reauthorizes an app install. The installer grants the permissions, content security policy entries, and endpoints that the version being installed requests. An account reauthorizes its own installs on any channel with its own key; app developers and embedding platforms reauthorize installs on connected accounts through Stripe-Account. For private apps, the version being installed is the newest completed upload.

Throws:

StripeException

update

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

Reauthorizes an app install. The installer grants the permissions, content security policy entries, and endpoints that the version being installed requests. An account reauthorizes its own installs on any channel with its own key; app developers and embedding platforms reauthorize installs on connected accounts through Stripe-Account. For private apps, the version being installed is the newest completed upload.

Throws:

StripeException

update

public Install update(String id)
               throws StripeException

Reauthorizes an app install. The installer grants the permissions, content security policy entries, and endpoints that the version being installed requests. An account reauthorizes its own installs on any channel with its own key; app developers and embedding platforms reauthorize installs on connected accounts through Stripe-Account. For private apps, the version being installed is the newest completed upload.

Throws:

StripeException

update

public Install update(String id,
 InstallUpdateParams params,
 RequestOptions options)
               throws StripeException

Reauthorizes an app install. The installer grants the permissions, content security policy entries, and endpoints that the version being installed requests. An account reauthorizes its own installs on any channel with its own key; app developers and embedding platforms reauthorize installs on connected accounts through Stripe-Account. For private apps, the version being installed is the newest completed upload.

Throws:

StripeException

uninstall

public Install uninstall(String id,
 InstallUninstallParams params)
                  throws StripeException

Uninstalls an app from the account that installed it.

Throws:

StripeException

uninstall

public Install uninstall(String id,
 RequestOptions options)
                  throws StripeException

Uninstalls an app from the account that installed it.

Throws:

StripeException

uninstall

public Install uninstall(String id)
                  throws StripeException

Uninstalls an app from the account that installed it.

Throws:

StripeException

uninstall

public Install uninstall(String id,
 InstallUninstallParams params,
 RequestOptions options)
                  throws StripeException

Uninstalls an app from the account that installed it.

Throws:

StripeException