Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CaffeineLab committed May 15, 2024
1 parent 753e539 commit 2b0362b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ print(auth_token)
Just a reference function for pulling the list of portfolios for the current organization.
```
portfolio_id, response = bloom.get_portfolios(
audience=<audience>,
auth_token=auth_token
)
```
Expand All @@ -75,7 +74,6 @@ consumer_info = {
}
consumer_id, response = bloom.register_consumer(
audience="<audience>",
consumer_info=consumer_info,
auth_token=auth_token
)
Expand All @@ -84,7 +82,6 @@ consumer_id, response = bloom.register_consumer(
### Order Credit Data
```
credit_order, response = bloom.order_credit_data(
audience='<audience>',
consumer_id=consumer_id,
portfolio_id=portfolio_id,
sku="equifax-gold-soft-fico-internet",
Expand All @@ -96,9 +93,8 @@ credit_order, response = bloom.order_credit_data(
If you use the outfile parameter, it will save the response from Bloom Credit into the given filepath.
```
credit_data, response = bloom.get_credit_data(
audience="<audience>",
order_id=credit_order,
auth_token=auth_token,
outfile="/path/to/file.json"
outfile="credit_data.json"
)
```
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

HERE = pathlib.Path(__file__).parent

VERSION = '0.1.7'
VERSION = '0.1.9'
PACKAGE_NAME = 'bloomcredit-python'
AUTHOR = 'Glenn'
AUTHOR_EMAIL = 'glenn@caffeinelab.com'
Expand Down
6 changes: 3 additions & 3 deletions src/bloom/bloom.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ def get_portfolios(auth_token, audience=None):
# register_consumer
# -----------------------------------------------------------------------------

def register_consumer(audience, consumer_info, auth_token):
def register_consumer(consumer_info, auth_token, audience=None):
""" Consumers are representations of persons within the Bloom API.
To order a credit report for a consumer, you first need to submit their information to Bloom.
https://developers.bloomcredit.io/docs/onboarding-to-first-credit-report#creating-a-consumer
Expand Down Expand Up @@ -168,7 +168,7 @@ def register_consumer(audience, consumer_info, auth_token):
# -----------------------------------------------------------------------------
# order_credit_data
# -----------------------------------------------------------------------------
def order_credit_data(audience, consumer_id, portfolio_id, sku, auth_token):
def order_credit_data(consumer_id, portfolio_id, sku, auth_token, audience=None):
""" Once your consumer is created, you can order a credit report via the
Bloom API. This order will be made for Bloom to fetch the credit report
for your order.
Expand Down Expand Up @@ -218,7 +218,7 @@ def order_credit_data(audience, consumer_id, portfolio_id, sku, auth_token):
# get_credit_data
# -----------------------------------------------------------------------------

def get_credit_data(audience, order_id, auth_token, outfile=None):
def get_credit_data(order_id, auth_token, audience=None, outfile=None):

if coalesce(audience, os.getenv('BLOOM_AUDIENCE')) == 'dev-api':
url = os.getenv('BLOOM_SANDBOX_ORDERS_URL')
Expand Down

0 comments on commit 2b0362b

Please sign in to comment.