from plaid.api.api import API


class Institutions(API):
    '''
    Institutions endpoints.
    (`HTTP docs <https://plaid.com/docs/api/#institutions>`__)
    '''

    def get(self, country_codes, count, offset=0, _options=None):
        '''
        Fetch all Plaid institutions, using /institutions/all.

        :param  [str]   country_codes:  Country codes of institutions to fetch.
        :param  int     count:          Number of institutions to fetch.
        :param  int     offset:         Number of institutions to skip.
        '''

        options = _options or {}

        return self.client.post('/institutions/get', {
            'country_codes': country_codes,
            'count': count,
            'offset': offset,
            'options': options,
        })

    def get_by_id(self, institution_id, country_codes, _options=None):
        '''
        Fetch a single institution by id.

        :param  [str]   country_codes:  Country codes of institution to fetch.
        :param  str     institution_id:
        '''
        options = _options or {}

        return self.client.post('/institutions/get_by_id', {
            'country_codes': country_codes,
            'institution_id': institution_id,
            'options': options,
        })

    def search(self, query, country_codes, _options=None, products=None):
        '''
        Search all institutions by name.

        :param  [str]   country_codes:  Country codes of institutions to fetch.
        :param  str     query:          Query against the full list of
                                         institutions.
        :param  [str]   products:       Filter FIs by available products.
                                         Optional.
        '''
        options = _options or {}

        return self.client.post('/institutions/search', {
            'country_codes': country_codes,
            'query': query,
            'products': products,
            'options': options,
        })