lib/plaid/api/plaid_api.rb
# Force a Sandbox Item into an error state
# &#x60;/sandbox/item/reset_login/&#x60; forces an Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment.  After calling &#x60;/sandbox/item/reset_login&#x60;, You can then use Plaid Link update mode to restore the Item to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; webhook will also be fired after a call to this endpoint, if one is associated with the Item.   In the Sandbox, Items will transition to an &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.
# @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest] 
# @param [Hash] opts the optional parameters
# @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
Force a Sandbox Item into an error state
`/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode] flow in the Sandbox environment.  After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item.   In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
Force a Sandbox Item into an error state ` / sandbox / item / reset_login / ` forces an Item into an ` ITEM_LOGIN_REQUIRED ` state in order to simulate an Item whose login is no longer valid . This makes it easy to test Link ' s [ update mode ] flow in the Sandbox environment . After calling ` / sandbox / item / reset_login ` You can then use Plaid Link update mode to restore the Item to a good state . An ` ITEM_LOGIN_REQUIRED ` webhook will also be fired after a call to this endpoint if one is associated with the Item . In the Sandbox Items will transition to an ` ITEM_LOGIN_REQUIRED ` error state automatically after 30 days even if this endpoint is not called .
def sandbox_item_reset_login_with_http_info(sandbox_item_reset_login_request, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_item_reset_login ...'
      end
      if @api_client.config.client_side_validation && sandbox_item_reset_login_request.nil?
        fail ArgumentError, "Missing the required parameter 'sandbox_item_reset_login_request' when calling PlaidApi.sandbox_item_reset_login"
      end
      local_var_path = '/sandbox/item/reset_login'
      query_params = opts[:query_params] || {}
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_item_reset_login_request)
      return_type = opts[:debug_return_type] || 'SandboxItemResetLoginResponse'
      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
      new_options = opts.merge(
        :operation => :"PlaidApi.sandbox_item_reset_login",
        :header_params => header_params,
        :query_params => query_params,
        :form_params => form_params,
        :body => post_body,
        :auth_names => auth_names,
        :return_type => return_type
      )
      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
      if @api_client.config.debugging
        @api_client.config.logger.debug "API called: PlaidApi#sandbox_item_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def sandbox_item_reset_login_with_http_info ( sandbox_item_reset_login_request , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PlaidApi.sandbox_item_reset_login ...' end if @api_client . config . client_side_validation && sandbox_item_reset_login_request . nil? fail ArgumentError , "Missing the required parameter 'sandbox_item_reset_login_request' when calling PlaidApi.sandbox_item_reset_login" end local_var_path = '/sandbox/item/reset_login' query_params = opts [ :query_params ] || { } header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) header_params [ 'Content-Type' ] = @api_client . select_header_content_type ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] || @api_client . object_to_http_body ( sandbox_item_reset_login_request ) return_type = opts [ :debug_return_type ] || 'SandboxItemResetLoginResponse' auth_names = opts [ :debug_auth_names ] || [ 'clientId' , 'plaidVersion' , 'secret' ] new_options = opts . merge ( :operation => :" PlaidApi.sandbox_item_reset_login " , :header_params => header_params , :query_params => query_params , :form_params => form_params , :body => post_body , :auth_names => auth_names , :return_type => return_type ) data , status_code , headers = @api_client . call_api ( :POST , local_var_path , new_options ) if @api_client . config . debugging @api_client . config . logger . debug "API called: PlaidApi#sandbox_item_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Force a Sandbox Item into an error state
&#x60;/sandbox/item/reset_login/&#x60; forces an Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid.
Force a Sandbox Item into an error state &#x60 ; / sandbox / item / reset_login / &#x60 ; forces an Item into an &#x60 ; ITEM_LOGIN_REQUIRED&#x60 ; state in order to simulate an Item whose login is no longer valid .
# verify the required parameter 'sandbox_item_reset_login_request' is set # resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # HTTP header 'Content-Type' # form parameters # http body (model) # return_type # auth_names
SandboxItemResetLoginResponse data, response status code and response headers
SandboxItemResetLoginResponse data response status code and response headers
Array<(SandboxItemResetLoginResponse, Integer, Hash)>
sandbox_item_reset_login_request
opts
None
opts the optional parameters
opts the optional parameters