action yodlee_edit_credentials_or_refresh_provider_account {
  label: "Update Account"
  description: "The update account API is used to:<br> <ul><li>Retrieve the latest information for accounts that belong to one providerAccount from the provider site. You must allow at least 15 min between requests.<li>Retrieve the latest information of all the eligible accounts that belong to the user.<li>Data to be retrieved from the provider site can be overridden using datasetName or dataset. If you do pass datasetName, all the datasets that are implicitly configured for the dataset will be retrieved. This action is allowed for single provider account refresh flows only.<li>Check the status of the providerAccount before invoking this API. Do not call this API to trigger any action on a providerAccount when an action is already in progress for the providerAccount.<li>If the customer has subscribed to the REFRESH event notification and invoked this API, relevant notifications will be sent to the customer.<li>A dataset may depend on another dataset for retrieval, so the response will include the requested and dependent datasets.<li>Check all the dataset additional statuses returned in the response because the provider account status is drawn from the dataset additional statuses.<li>Updating preferences using this API will trigger refreshes.<li> The content type has to be passed as application/json for the body parameter.</ul><br>-----------------------------------------------------------------------------------------------------------------------------------------<br><br><b>Update All Eligible Accounts - Notes:</b><br><ul><li>This API will trigger a refresh for all the eligible provider accounts(both OB and credential-based accounts).<li>This API will not refresh closed, inactive, or UAR accounts, or accounts with refreshes in-progress or recently refreshed non-OB accounts.<li>No parameters should be passed to this API to trigger this action.<li>Do not call this API often. Our recommendation is to call this only at the time the user logs in to your app because it can hamper other API calls performance.<li>The response only contains information for accounts that were refreshed. If no accounts are eligible for refresh, no response is returned.</ul>"
  provider: yodlee
  method: PUT
  path: "/providerAccounts"
  encoding: json
  input: {
    type: "object"
    properties: {
      aggregationSource: {
        type: "string"
        enum: ["SYSTEM", "USER"]
      }
      consentId: {
        type: "integer"
        format: "int64"
        description: "Consent Id generated for the request through POST Consent.<br><br><b>Endpoints</b>:<ul><li>POST Provider Account</li><li>PUT Provider Account</li></ul>"
      }
      dataset: {
        type: "array"
        items: {
          type: "object"
          properties: {
            attribute: {
              type: "array"
              description: "The name of the dataset attribute suported by the provider.<br><br><b>Endpoints</b>:<ul><li>GET providers/{providerId}</li><li>GET providers</li></ul>"
              items: {
                type: "object"
                properties: {
                  container: {
                    type: "array"
                    description: "Containers for which the attributes are supported.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>"
                    items: {
                      type: "string"
                      enum: ["bank", "creditCard", "investment", "insurance", "loan", "reward", "realEstate", "otherAssets", "otherLiabilities"]
                    }
                  }
                  containerAttributes: {
                    type: "object"
                    properties: {
                      BANK: {
                        type: "object"
                        properties: {
                          fullAccountNumberFields: {
                            type: "array"
                            items: {
                              type: "object"
                              additionalProperties: true
                            }
                          }
                          numberOfTransactionDays: {
                            type: "integer"
                            format: "int32"
                          }
                        }
                      }
                      CREDITCARD: {
                        type: "object"
                        additionalProperties: true
                      }
                      INSURANCE: {
                        type: "object"
                        additionalProperties: true
                      }
                      INVESTMENT: {
                        type: "object"
                        additionalProperties: true
                      }
                      LOAN: {
                        type: "object"
                        additionalProperties: true
                      }
                    }
                  }
                  fromDate: {
                    type: "string"
                    description: "Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>"
                  }
                  fromFinYear: {
                    type: "string"
                    description: "Applicable only to TAX attribute of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>"
                  }
                  name: {
                    type: "string"
                    description: "Attributes that are supported for a dataset.<br><br><b>Endpoints</b>:<ul><li>GET providers</li><li>GET providers/{providerId}</li></ul>"
                    enum: ["BASIC_ACCOUNT_INFO", "TRANSACTIONS", "STATEMENTS", "HOLDINGS", "ACCOUNT_DETAILS", "TAX", "EBILLS", "FULL_ACCT_NUMBER", "BANK_TRANSFER_CODE", "HOLDER_NAME", "HOLDER_DETAILS", "PAYMENT_PROFILE", "PAYMENT_DETAILS", "INTEREST_DETAILS", "COVERAGE"]
                  }
                  toDate: {
                    type: "string"
                    description: "Applicable only to EBILLS and STATEMENTS attributes of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>"
                  }
                  toFinYear: {
                    type: "string"
                    description: "Applicable only to TAX attribute of DOCUMENT dataset.<br><br><b>Endpoints</b>:<ul><li>POST providerAccounts</li><li>PUT providerAccounts</li></ul>"
                  }
                }
              }
            }
            name: {
              type: "string"
              description: "The name of the dataset requested from the provider site<br><br><b>Account Type</b>: Manual<br><b>Endpoints</b>:<ul><li>GET accounts</li><li>GET accounts/{accountId}</li><li>GET providerAccounts</li><li>POST providerAccounts</li><li>PUT providerAccounts/{providerAccountId}</li><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li><li>GET providers</li></ul><b>Applicable Values</b><br>"
              enum: ["BASIC_AGG_DATA", "ADVANCE_AGG_DATA", "ACCT_PROFILE", "DOCUMENT"]
            }
          }
        }
      }
      datasetName: {
        type: "array"
        items: {
          type: "string"
          enum: ["BASIC_AGG_DATA", "ADVANCE_AGG_DATA", "ACCT_PROFILE", "DOCUMENT"]
        }
      }
      field: {
        type: "array"
        items: {
          type: "object"
          properties: {
            id: {
              type: "string"
              description: "Identifier for the field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
            image: {
              type: "string"
              description: "Image displayed at the endsite.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li></ul>"
            }
            isOptional: {
              type: "boolean"
              description: "Indicates if a field is an optional field or a mandatory field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
            isValueProvided: {
              type: "boolean"
              description: "Indicates that the answer to the security question already exists in the Yodlee system.Persuading the user to provide the answer to the security question again during the edit-credential flow can be avoided.<br><br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=questions</li><li>GET providerAccounts/{providerAccountId}? include=questions</li></ul>"
            }
            maxLength: {
              type: "integer"
              format: "int64"
              description: "The maximum length of the login form field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
            minLength: {
              type: "integer"
              format: "int64"
              description: "The minimum length of the login form field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
            name: {
              type: "string"
              description: "Name of the field.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
            option: {
              type: "array"
              description: "Provides the different values that are available for the user to choose. This field is applicable for drop-down or radio field types.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
              items: {
                type: "object"
                properties: {
                  displayText: {
                    type: "string"
                    description: "The text that is displayed to the user for that option in the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
                  }
                  isSelected: {
                    type: "boolean"
                    description: "The option that is selected by default in the provider site.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
                  }
                  optionValue: {
                    type: "string"
                    description: "The value that is associated with the option.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
                  }
                }
              }
            }
            prefix: {
              type: "string"
              description: "The prefix string that has to be displayed before the field value.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
            suffix: {
              type: "string"
              description: "The suffix string that has to be displayed next to the field value.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
            type: {
              type: "string"
              description: "This indicates the display type of the field. For example, text box, image, etc. <br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul><b>Applicable Values</b><br>"
              enum: ["text", "password", "option", "checkbox", "radio", "image"]
            }
            value: {
              type: "string"
              description: "Value expected from the user for the field. This will be blank and is expected to be filled and sent back when submitting the login or MFA information.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
            valueEditable: {
              type: "string"
              description: "Indicates whether the field is editable or not.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts/{providerAccountId}</li><li>GET providers/{providerId}</li></ul>"
            }
          }
        }
      }
      preferences: {
        type: "object"
        properties: {
          isAutoRefreshEnabled: {
            type: "boolean"
            description: "Indicates if auto-refreshes have to be triggered for the provider account.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>"
          }
          isDataExtractsEnabled: {
            type: "boolean"
            description: "Indicates if the updates to the provider account should be part of the data extracts event notification or the data extract data retrieval service.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>"
          }
          linkedProviderAccountId: {
            type: "integer"
            format: "int64"
            description: "LinkedproviderAccountd is a providerAccountId linked by the user to the primary provider account. <br>LinkedProviderAccountId and the providerAccountId belongs to the same institution.<br><br><b>Endpoints</b>:<ul><li>POST Provider Account</li><li>PUT Provider Account</li><li>GET Provider Accounts</li></ul>"
          }
        }
      }
      providerAccountIds: {
        type: "string"
      }
    }
    required: ["field", "providerAccountIds"]
    additionalProperties: false
  }
  output: {
    type: "object"
    additionalProperties: true
  }
}