Enterprise

class TheNounProjectAPI.enterprise.Enterprise(key=None, secret=None, testing=False, timeout=5.0)

Bases: TheNounProjectAPI.core.Core

Construct a new object for making API requests.

Parameters

  • key (str) – The API key from the TheNounProject API. (defaults to None)

  • secret (str) – The secret key from the TheNounProject API. (defaults to None)

  • testing (bool) – Whether the methods should return a PreparedRequest, instead of data from the API. Should not be used except for testing this wrapper. (defaults to False)

  • timeout (Union[float, Tuple[float, float], None]) – Float timeout in seconds, 2-tuples for seperate connect and read timeouts, and None for no timeout. (defaults to 5.0)

report_usage(icons, test=False)

Accepts icon ids for reporting icon usage.

Parameters

  • icons (Union[list, set, str, int]) – Icon ids.

  • test (bool) – True to test endpoint without reporting data.

Returns

EnterpriseModel object based on the icon ids.

Return type

EnterpriseModel