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
public class Install extends ApiResource implements HasId
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.

  • Constructor Details

    • Install

      public Install()

  • Method Details

    • create

      public static Install create(Map<String,Object> 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 static Install create(Map<String,Object> 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

    • create

      public static 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 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 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

    • list

      public static InstallCollection list(Map<String,Object> 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 static InstallCollection list(Map<String,Object> 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

    • list

      public static InstallCollection 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 static InstallCollection 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

    • retrieve

      public static 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 static 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 static Install retrieve(String id, Map<String,Object> 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

    • 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

      public Install uninstall() throws StripeException
      Uninstalls an app from the account that installed it.
      Throws:
      StripeException

    • uninstall

      public Install uninstall(RequestOptions options) throws StripeException
      Uninstalls an app from the account that installed it.
      Throws:
      StripeException

    • uninstall

      public Install uninstall(Map<String,Object> params) throws StripeException
      Uninstalls an app from the account that installed it.
      Throws:
      StripeException

    • uninstall

      public Install uninstall(Map<String,Object> params, RequestOptions options) throws StripeException
      Uninstalls an app from the account that installed it.
      Throws:
      StripeException

    • uninstall

      public Install uninstall(InstallUninstallParams params) throws StripeException
      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

      public Install update(Map<String,Object> 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(Map<String,Object> 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

    • update

      public Install update(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(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

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAccount

      public String getAccount()
      The ID of the account that the app install belongs to.

    • getApp

      public String getApp()
      The ID of the app installed.

    • getApprovalRequired

      public Boolean getApprovalRequired()
      Whether the installer must authorize pending permissions, content security policy entries, or endpoints. For private apps, approval_required stays false; creating or reauthorizing the install through the API installs the newest completed upload and grants its permissions.

    • getAuthCode

      public String getAuthCode()
      The authorization code for an oauth app install.

    • getChannel

      public String getChannel()
      The distribution channel associated with the app install.

      One of private_live, private_test, public, review, or testing.

    • getContentSecurityPolicyGranted

      public Install.ContentSecurityPolicyGranted getContentSecurityPolicyGranted()

    • getContentSecurityPolicyPending

      public Install.ContentSecurityPolicyPending getContentSecurityPolicyPending()

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCreatedBy

      public String getCreatedBy()
      The ID of the embedding platform that created the install, if applicable.

    • getEndpointsGranted

      public List<String> getEndpointsGranted()
      The endpoint URLs authorized by the installer.

    • getEndpointsPending

      public List<String> getEndpointsPending()
      The endpoint URLs requested by the latest app version that the installer has not authorized.

    • getLivemode

      public Boolean getLivemode()
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to apps.install.

    • getPermissionsGranted

      public List<String> getPermissionsGranted()
      The permissions authorized by the installer.

    • getPermissionsPending

      public List<String> getPermissionsPending()
      The permissions requested by the latest app version that the installer has not authorized.

    • getStatus

      public String getStatus()
      The status of the app install.

      One of install_failed, installed, installing, uninstall_failed, or uninstalling.

    • setAccount

      public void setAccount(String account)
      The ID of the account that the app install belongs to.

    • setApp

      public void setApp(String app)
      The ID of the app installed.

    • setApprovalRequired

      public void setApprovalRequired(Boolean approvalRequired)
      Whether the installer must authorize pending permissions, content security policy entries, or endpoints. For private apps, approval_required stays false; creating or reauthorizing the install through the API installs the newest completed upload and grants its permissions.

    • setAuthCode

      public void setAuthCode(String authCode)
      The authorization code for an oauth app install.

    • setChannel

      public void setChannel(String channel)
      The distribution channel associated with the app install.

      One of private_live, private_test, public, review, or testing.

    • setContentSecurityPolicyGranted

      public void setContentSecurityPolicyGranted(Install.ContentSecurityPolicyGranted contentSecurityPolicyGranted)

    • setContentSecurityPolicyPending

      public void setContentSecurityPolicyPending(Install.ContentSecurityPolicyPending contentSecurityPolicyPending)

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCreatedBy

      public void setCreatedBy(String createdBy)
      The ID of the embedding platform that created the install, if applicable.

    • setEndpointsGranted

      public void setEndpointsGranted(List<String> endpointsGranted)
      The endpoint URLs authorized by the installer.

    • setEndpointsPending

      public void setEndpointsPending(List<String> endpointsPending)
      The endpoint URLs requested by the latest app version that the installer has not authorized.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to apps.install.

    • setPermissionsGranted

      public void setPermissionsGranted(List<String> permissionsGranted)
      The permissions authorized by the installer.

    • setPermissionsPending

      public void setPermissionsPending(List<String> permissionsPending)
      The permissions requested by the latest app version that the installer has not authorized.

    • setStatus

      public void setStatus(String status)
      The status of the app install.

      One of install_failed, installed, installing, uninstall_failed, or uninstalling.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId