Package com.stripe.model.apps
Class Install
java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.apps.Install
- All Implemented Interfaces:
HasId,StripeActiveObject,StripeObjectInterface
An app install represents a Stripe App that is installed on an account. It reports the
permissions, content security policy entries, and endpoints that the installing account has
authorized, along with any that the app's latest version requests but the account has not
authorized yet. Use the Install API to install, reauthorize, and uninstall apps, and to check the
state of existing installs.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classFor more details about ContentSecurityPolicyGranted, please refer to the API Reference.static classFor more details about ContentSecurityPolicyPending, please refer to the API Reference.Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod -
Field Summary
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON, INTERNAL_GSONFields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanstatic Installcreate(InstallCreateParams params) Creates an app install.static Installcreate(InstallCreateParams params, RequestOptions options) Creates an app install.static InstallCreates an app install.static Installcreate(Map<String, Object> params, RequestOptions options) Creates an app install.booleanThe ID of the account that the app install belongs to.getApp()The ID of the app installed.Whether the installer must authorize pending permissions, content security policy entries, or endpoints.The authorization code for an oauth app install.The distribution channel associated with the app install.Time at which the object was created.The ID of the embedding platform that created the install, if applicable.The endpoint URLs authorized by the installer.The endpoint URLs requested by the latest app version that the installer has not authorized.getId()Unique identifier for the object.If the object exists in live mode, the value istrue.String representing the object's type.The permissions authorized by the installer.The permissions requested by the latest app version that the installer has not authorized.The status of the app install.inthashCode()static InstallCollectionlist(InstallListParams params) Returns a list of app installs.static InstallCollectionlist(InstallListParams params, RequestOptions options) Returns a list of app installs.static InstallCollectionReturns a list of app installs.static InstallCollectionlist(Map<String, Object> params, RequestOptions options) Returns a list of app installs.static InstallRetrieves an app install.static Installretrieve(String id, RequestOptions options) Retrieves an app install.static Installretrieve(String id, InstallRetrieveParams params, RequestOptions options) Retrieves an app install.static InstallRetrieves an app install.voidsetAccount(String account) The ID of the account that the app install belongs to.voidThe ID of the app installed.voidsetApprovalRequired(Boolean approvalRequired) Whether the installer must authorize pending permissions, content security policy entries, or endpoints.voidsetAuthCode(String authCode) The authorization code for an oauth app install.voidsetChannel(String channel) The distribution channel associated with the app install.voidsetContentSecurityPolicyGranted(Install.ContentSecurityPolicyGranted contentSecurityPolicyGranted) voidsetContentSecurityPolicyPending(Install.ContentSecurityPolicyPending contentSecurityPolicyPending) voidsetCreated(Long created) Time at which the object was created.voidsetCreatedBy(String createdBy) The ID of the embedding platform that created the install, if applicable.voidsetEndpointsGranted(List<String> endpointsGranted) The endpoint URLs authorized by the installer.voidsetEndpointsPending(List<String> endpointsPending) The endpoint URLs requested by the latest app version that the installer has not authorized.voidUnique identifier for the object.voidsetLivemode(Boolean livemode) If the object exists in live mode, the value istrue.voidString representing the object's type.voidsetPermissionsGranted(List<String> permissionsGranted) The permissions authorized by the installer.voidsetPermissionsPending(List<String> permissionsPending) The permissions requested by the latest app version that the installer has not authorized.voidThe status of the app install.Uninstalls an app from the account that installed it.uninstall(RequestOptions options) Uninstalls an app from the account that installed it.uninstall(InstallUninstallParams params) Uninstalls an app from the account that installed it.uninstall(InstallUninstallParams params, RequestOptions options) Uninstalls an app from the account that installed it.Uninstalls an app from the account that installed it.uninstall(Map<String, Object> params, RequestOptions options) Uninstalls an app from the account that installed it.update(InstallUpdateParams params) Reauthorizes an app install.update(InstallUpdateParams params, RequestOptions options) Reauthorizes an app install.Reauthorizes an app install.update(Map<String, Object> params, RequestOptions options) Reauthorizes an app install.Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, setResponseGetter, urlEncode, urlEncodeIdMethods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.stripe.model.StripeActiveObject
trySetResponseGetter
-
Constructor Details
-
Install
public Install()
-
-
Method Details
-
create
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 acting on a connected account throughStripe-Accountinstalls or reinstalls its app there, and an embedding platform can do the same once the app’s developer approves its request to embed the app and the platform has accepted the Embedding Platform Terms and Conditions in the Dashboard. 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 static Install create(Map<String, Object> params, RequestOptions options) throws StripeExceptionCreates 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 acting on a connected account throughStripe-Accountinstalls or reinstalls its app there, and an embedding platform can do the same once the app’s developer approves its request to embed the app and the platform has accepted the Embedding Platform Terms and Conditions in the Dashboard. 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
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 acting on a connected account throughStripe-Accountinstalls or reinstalls its app there, and an embedding platform can do the same once the app’s developer approves its request to embed the app and the platform has accepted the Embedding Platform Terms and Conditions in the Dashboard. 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 static 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 acting on a connected account throughStripe-Accountinstalls or reinstalls its app there, and an embedding platform can do the same once the app’s developer approves its request to embed the app and the platform has accepted the Embedding Platform Terms and Conditions in the Dashboard. 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
-
list
Returns a list of app installs. An app developer filtering by its own app with its own key sees that app’s installs across the accounts that installed it. An app developer acting on a connected account throughStripe-Accountand filtering by its app sees that account’s installs of the app, and an embedding platform acting on a connected account sees only the installs it created there. Other callers see the installs on their own account. A live key lists live installs and a test key lists test installs; the key of an app’s managed sandbox filtering byapplists that app’s installs across every sandbox, and also that app’s legacy test mode installs when the developer has no legacy test mode.- Throws:
StripeException
-
list
public static InstallCollection list(Map<String, Object> params, RequestOptions options) throws StripeExceptionReturns a list of app installs. An app developer filtering by its own app with its own key sees that app’s installs across the accounts that installed it. An app developer acting on a connected account throughStripe-Accountand filtering by its app sees that account’s installs of the app, and an embedding platform acting on a connected account sees only the installs it created there. Other callers see the installs on their own account. A live key lists live installs and a test key lists test installs; the key of an app’s managed sandbox filtering byapplists that app’s installs across every sandbox, and also that app’s legacy test mode installs when the developer has no legacy test mode.- Throws:
StripeException
-
list
Returns a list of app installs. An app developer filtering by its own app with its own key sees that app’s installs across the accounts that installed it. An app developer acting on a connected account throughStripe-Accountand filtering by its app sees that account’s installs of the app, and an embedding platform acting on a connected account sees only the installs it created there. Other callers see the installs on their own account. A live key lists live installs and a test key lists test installs; the key of an app’s managed sandbox filtering byapplists that app’s installs across every sandbox, and also that app’s legacy test mode installs when the developer has no legacy test mode.- Throws:
StripeException
-
list
public static InstallCollection list(InstallListParams params, RequestOptions options) throws StripeException Returns a list of app installs. An app developer filtering by its own app with its own key sees that app’s installs across the accounts that installed it. An app developer acting on a connected account throughStripe-Accountand filtering by its app sees that account’s installs of the app, and an embedding platform acting on a connected account sees only the installs it created there. Other callers see the installs on their own account. A live key lists live installs and a test key lists test installs; the key of an app’s managed sandbox filtering byapplists that app’s installs across every sandbox, and also that app’s legacy test mode installs when the developer has no legacy test mode.- Throws:
StripeException
-
retrieve
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
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 static Install retrieve(String id, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves 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 static 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
-
uninstall
Uninstalls an app from the account that installed it.- Throws:
StripeException
-
uninstall
Uninstalls an app from the account that installed it.- Throws:
StripeException
-
uninstall
Uninstalls an app from the account that installed it.- Throws:
StripeException
-
uninstall
Uninstalls an app from the account that installed it.- Throws:
StripeException
-
uninstall
Uninstalls an app from the account that installed it.- Throws:
StripeException
-
uninstall
public Install uninstall(InstallUninstallParams params, RequestOptions options) throws StripeException Uninstalls an app from the account that installed it.- Throws:
StripeException
-
update
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, which grants all of that access, so only giveapp_install_writeto keys that may approve an app’s access. App developers and embedding platforms reauthorize installs on connected accounts throughStripe-Account. An app developer can’t grant new access. An embedding platform can grant new access only once the app’s developer approves its request to embed the app. For private apps, the version being installed is the newest completed upload.- Throws:
StripeException
-
update
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, which grants all of that access, so only giveapp_install_writeto keys that may approve an app’s access. App developers and embedding platforms reauthorize installs on connected accounts throughStripe-Account. An app developer can’t grant new access. An embedding platform can grant new access only once the app’s developer approves its request to embed the app. For private apps, the version being installed is the newest completed upload.- Throws:
StripeException
-
update
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, which grants all of that access, so only giveapp_install_writeto keys that may approve an app’s access. App developers and embedding platforms reauthorize installs on connected accounts throughStripe-Account. An app developer can’t grant new access. An embedding platform can grant new access only once the app’s developer approves its request to embed the app. For private apps, the version being installed is the newest completed upload.- Throws:
StripeException
-
update
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, which grants all of that access, so only giveapp_install_writeto keys that may approve an app’s access. App developers and embedding platforms reauthorize installs on connected accounts throughStripe-Account. An app developer can’t grant new access. An embedding platform can grant new access only once the app’s developer approves its request to embed the app. For private apps, the version being installed is the newest completed upload.- Throws:
StripeException
-
getAccount
The ID of the account that the app install belongs to. -
getApp
The ID of the app installed. -
getApprovalRequired
Whether the installer must authorize pending permissions, content security policy entries, or endpoints. For private apps,approval_requiredstaysfalse; creating or reauthorizing the install through the API installs the newest completed upload and grants its permissions. -
getAuthCode
The authorization code for an oauth app install. -
getChannel
The distribution channel associated with the app install.One of
private_live,private_test,public,review, ortesting. -
getContentSecurityPolicyGranted
-
getContentSecurityPolicyPending
-
getCreated
Time at which the object was created. Measured in seconds since the Unix epoch. -
getCreatedBy
The ID of the embedding platform that created the install, if applicable. -
getEndpointsGranted
The endpoint URLs authorized by the installer. -
getEndpointsPending
The endpoint URLs requested by the latest app version that the installer has not authorized. -
getLivemode
If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse. -
getObject
String representing the object's type. Objects of the same type share the same value.Equal to
apps.install. -
getPermissionsGranted
The permissions authorized by the installer. -
getPermissionsPending
The permissions requested by the latest app version that the installer has not authorized. -
getStatus
The status of the app install.One of
install_failed,installed,installing,uninstall_failed, oruninstalling. -
setAccount
The ID of the account that the app install belongs to. -
setApp
The ID of the app installed. -
setApprovalRequired
Whether the installer must authorize pending permissions, content security policy entries, or endpoints. For private apps,approval_requiredstaysfalse; creating or reauthorizing the install through the API installs the newest completed upload and grants its permissions. -
setAuthCode
The authorization code for an oauth app install. -
setChannel
The distribution channel associated with the app install.One of
private_live,private_test,public,review, ortesting. -
setContentSecurityPolicyGranted
public void setContentSecurityPolicyGranted(Install.ContentSecurityPolicyGranted contentSecurityPolicyGranted) -
setContentSecurityPolicyPending
public void setContentSecurityPolicyPending(Install.ContentSecurityPolicyPending contentSecurityPolicyPending) -
setCreated
Time at which the object was created. Measured in seconds since the Unix epoch. -
setCreatedBy
The ID of the embedding platform that created the install, if applicable. -
setEndpointsGranted
The endpoint URLs authorized by the installer. -
setEndpointsPending
The endpoint URLs requested by the latest app version that the installer has not authorized. -
setId
Unique identifier for the object. -
setLivemode
If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse. -
setObject
String representing the object's type. Objects of the same type share the same value.Equal to
apps.install. -
setPermissionsGranted
The permissions authorized by the installer. -
setPermissionsPending
The permissions requested by the latest app version that the installer has not authorized. -
setStatus
The status of the app install.One of
install_failed,installed,installing,uninstall_failed, oruninstalling. -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object.
-