Class InstallService

java.lang.Object
com.stripe.net.ApiService
com.stripe.service.apps.InstallService

public final class InstallService extends ApiService
  • Constructor Details

  • Method Details

    • 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 through Stripe-Account and 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 by app lists 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 StripeCollection<Install> list(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 through Stripe-Account and 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 by app lists 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 StripeCollection<Install> list() 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 through Stripe-Account and 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 by app lists 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 through Stripe-Account and 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 by app lists 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
    • 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 acting on a connected account through Stripe-Account installs 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 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 through Stripe-Account installs 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
    • 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, which grants all of that access, so only give app_install_write to keys that may approve an app’s access. App developers and embedding platforms reauthorize installs on connected accounts through Stripe-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

      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, which grants all of that access, so only give app_install_write to keys that may approve an app’s access. App developers and embedding platforms reauthorize installs on connected accounts through Stripe-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

      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, which grants all of that access, so only give app_install_write to keys that may approve an app’s access. App developers and embedding platforms reauthorize installs on connected accounts through Stripe-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

      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, which grants all of that access, so only give app_install_write to keys that may approve an app’s access. App developers and embedding platforms reauthorize installs on connected accounts through Stripe-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
    • 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