From 116bec46e51d92c7ca1b238d1a7a90fefce2e4a4 Mon Sep 17 00:00:00 2001 From: edu-stark Date: Wed, 16 Sep 2026 13:29:30 -0300 Subject: [PATCH 1/2] docs: make every docstring bullet parse under the house grammar The docstrings are the machine-readable reference for the other SDKs, the docs guard and the C tables. 217 bullets lost their colon and were invisible to a grammar-aware reader; 38 tags and 10 rules parameters among them. Co-Authored-By: Claude Sonnet 5 --- starkbank/boleto/__boleto.py | 8 ++--- starkbank/boleto/log/__log.py | 8 ++--- starkbank/boletoholmes/__boletoholmes.py | 8 ++--- starkbank/boletoholmes/log/__log.py | 8 ++--- starkbank/boletopayment/__boletopayment.py | 8 ++--- starkbank/boletopayment/log/__log.py | 8 ++--- starkbank/brcodepayment/__brcodepayment.py | 8 ++--- starkbank/brcodepayment/log/__log.py | 8 ++--- starkbank/corporatecard/__corporatecard.py | 8 ++--- starkbank/corporatecard/log/__log.py | 8 ++--- .../corporateholder/__corporateholder.py | 8 ++--- starkbank/corporateholder/log/__log.py | 8 ++--- .../corporateinvoice/__corporateinvoice.py | 8 ++--- .../corporatepurchase/__corporatepurchase.py | 8 ++--- starkbank/corporatepurchase/log/__log.py | 8 ++--- starkbank/corporaterule/__corporaterule.py | 6 ++-- .../__corporatetransaction.py | 8 ++--- .../__corporatewithdrawal.py | 10 +++--- starkbank/darfpayment/__darfpayment.py | 8 ++--- starkbank/darfpayment/log/__log.py | 8 ++--- starkbank/deposit/__deposit.py | 8 ++--- starkbank/deposit/log/__log.py | 8 ++--- starkbank/dictkey/__dictkey.py | 8 ++--- starkbank/event/attempt/__attempt.py | 8 ++--- starkbank/invoice/__invoice.py | 8 ++--- starkbank/invoice/log/__log.py | 8 ++--- .../__invoicepullrequest.py | 8 ++--- starkbank/invoicepullrequest/log/__log.py | 8 ++--- .../__invoicepullsubscription.py | 8 ++--- .../invoicepullsubscription/log/__log.py | 8 ++--- starkbank/merchantcard/__merchantcard.py | 20 +++++++---- starkbank/merchantcard/log/__log.py | 8 ++--- .../__merchantinstallment.py | 8 ++--- starkbank/merchantinstallment/log/__log.py | 8 ++--- .../merchantpurchase/__merchantpurchase.py | 25 +++++++++---- starkbank/merchantpurchase/log/__log.py | 8 ++--- .../merchantsession/__merchantsession.py | 8 ++--- starkbank/merchantsession/__purchase.py | 35 +++++++++++++++++++ starkbank/merchantsession/log/__log.py | 8 ++--- starkbank/split/__split.py | 8 ++--- starkbank/split/log/__log.py | 8 ++--- starkbank/splitprofile/__splitprofile.py | 4 +-- starkbank/splitprofile/log/__log.py | 8 ++--- starkbank/splitreceiver/log/__log.py | 8 ++--- starkbank/taxpayment/__taxpayment.py | 8 ++--- starkbank/taxpayment/log/__log.py | 8 ++--- starkbank/transaction/__transaction.py | 8 ++--- starkbank/transfer/log/__log.py | 8 ++--- starkbank/utilitypayment/__utilitypayment.py | 8 ++--- starkbank/utilitypayment/log/__log.py | 8 ++--- 50 files changed, 252 insertions(+), 200 deletions(-) diff --git a/starkbank/boleto/__boleto.py b/starkbank/boleto/__boleto.py index 29ee3d01..860e523b 100644 --- a/starkbank/boleto/__boleto.py +++ b/starkbank/boleto/__boleto.py @@ -123,8 +123,8 @@ def query(limit=None, status=None, tags=None, ids=None, after=None, before=None, Receive a generator of Boleto objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "paid" or "registered" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -151,8 +151,8 @@ def page(cursor=None, limit=None, status=None, tags=None, ids=None, after=None, ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "paid" or "registered" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/boleto/log/__log.py b/starkbank/boleto/log/__log.py index ca336eed..8a6ec544 100644 --- a/starkbank/boleto/log/__log.py +++ b/starkbank/boleto/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, after=None, before=None, types=None, boleto_ids=None, user Receive a generator of boleto.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: "paid" or "registered" - boleto_ids [list of strings, default None]: list of Boleto ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, boleto_id ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: "paid" or "registered" - boleto_ids [list of strings, default None]: list of Boleto ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/boletoholmes/__boletoholmes.py b/starkbank/boletoholmes/__boletoholmes.py index a2d2c2a3..013eb64e 100644 --- a/starkbank/boletoholmes/__boletoholmes.py +++ b/starkbank/boletoholmes/__boletoholmes.py @@ -65,8 +65,8 @@ def query(limit=None, after=None, before=None, tags=None, ids=None, status=None, Receive a generator of BoletoHolmes objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "solved" @@ -95,8 +95,8 @@ def page(cursor=None, limit=None, user=None): ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "solved" diff --git a/starkbank/boletoholmes/log/__log.py b/starkbank/boletoholmes/log/__log.py index 00eb7ebe..70457b14 100644 --- a/starkbank/boletoholmes/log/__log.py +++ b/starkbank/boletoholmes/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, after=None, before=None, types=None, holmes_ids=None, user Receive a generator of boletoholmes.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event type. ex: ["solving", "solved"] - holmes_ids [list of strings, default None]: list of BoletoHolmes ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, holmes_id ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event type. ex: ["solving", "solved"] - holmes_ids [list of strings, default None]: list of boletoholmes.Log ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/boletopayment/__boletopayment.py b/starkbank/boletopayment/__boletopayment.py index 14c736d3..d34dfa5a 100644 --- a/starkbank/boletopayment/__boletopayment.py +++ b/starkbank/boletopayment/__boletopayment.py @@ -90,8 +90,8 @@ def query(limit=None, after=None, before=None, tags=None, ids=None, status=None, Receive a generator of BoletoPayment objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" @@ -118,8 +118,8 @@ def page(cursor=None, limit=None, after=None, before=None, tags=None, ids=None, ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" diff --git a/starkbank/boletopayment/log/__log.py b/starkbank/boletopayment/log/__log.py index 67ca7990..9cc0e83c 100644 --- a/starkbank/boletopayment/log/__log.py +++ b/starkbank/boletopayment/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, after=None, before=None, types=None, payment_ids=None, use Receive a generator of boletopayment.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - payment_ids [list of strings, default None]: list of BoletoPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, payment_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - payment_ids [list of strings, default None]: list of boletopayment.Log ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/brcodepayment/__brcodepayment.py b/starkbank/brcodepayment/__brcodepayment.py index 77c407c3..c0c5211f 100644 --- a/starkbank/brcodepayment/__brcodepayment.py +++ b/starkbank/brcodepayment/__brcodepayment.py @@ -112,8 +112,8 @@ def query(limit=None, after=None, before=None, tags=None, ids=None, status=None, Receive a generator of BrcodePayment objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" @@ -140,8 +140,8 @@ def page(cursor=None, after=None, before=None, tags=None, ids=None, status=None, ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" diff --git a/starkbank/brcodepayment/log/__log.py b/starkbank/brcodepayment/log/__log.py index 3983627c..2dc19515 100644 --- a/starkbank/brcodepayment/log/__log.py +++ b/starkbank/brcodepayment/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, after=None, before=None, types=None, payment_ids=None, use Receive a generator of brcodepayment.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - payment_ids [list of strings, default None]: list of BrcodePayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, payment_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - payment_ids [list of strings, default None]: list of BrcodePayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/corporatecard/__corporatecard.py b/starkbank/corporatecard/__corporatecard.py index 6b5dd12e..31360c97 100644 --- a/starkbank/corporatecard/__corporatecard.py +++ b/starkbank/corporatecard/__corporatecard.py @@ -87,8 +87,8 @@ def query(limit=None, after=None, before=None, status=None, types=None, holder_i Receive a generator of CorporateCard objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [list of strings, default None]: filter for status of retrieved objects. ex: ["active", "blocked", "canceled", "expired"] - types [list of strings, default None]: card type. ex: ["virtual"] - holder_ids [list of strings, default None]: card holder IDs. ex: ["5656565656565656", "4545454545454545"] @@ -122,8 +122,8 @@ def page(cursor=None, limit=None, after=None, before=None, status=None, types=No ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [list of strings, default None]: filter for status of retrieved objects. ex: ["active", "blocked", "canceled", "expired"] - types [list of strings, default None]: card type. ex: ["virtual"] - holder_ids [list of strings, default None]: card holder IDs. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/corporatecard/log/__log.py b/starkbank/corporatecard/log/__log.py index 12e1f007..43e8fa5e 100644 --- a/starkbank/corporatecard/log/__log.py +++ b/starkbank/corporatecard/log/__log.py @@ -47,8 +47,8 @@ def query(limit=None, card_ids=None, types=None, after=None, before=None, ids=No Receive a generator of corporatecard.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["blocked", "canceled", "created", "expired", "unblocked", "updated"] - card_ids [list of strings, default None]: list of CorporateCard ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, card_ids= ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["blocked", "canceled", "created", "expired", "unblocked", "updated"] - card_ids [list of strings, default None]: list of CorporateCard ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/corporateholder/__corporateholder.py b/starkbank/corporateholder/__corporateholder.py index 9aa93ac1..0652fa74 100644 --- a/starkbank/corporateholder/__corporateholder.py +++ b/starkbank/corporateholder/__corporateholder.py @@ -74,8 +74,8 @@ def query(limit=None, after=None, before=None, ids=None, status=None, tags=None, Receive a generator of CorporateHolder objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [list of strings, default None]: filter for status of retrieved objects. ex: ["active", "blocked", "canceled"] - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] @@ -104,8 +104,8 @@ def page(cursor=None, limit=None, after=None, before=None, ids=None, status=None ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [list of strings, default None]: filter for status of retrieved objects. ex: ["active", "blocked", "canceled"] - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] diff --git a/starkbank/corporateholder/log/__log.py b/starkbank/corporateholder/log/__log.py index 43dc4ebb..60b526ef 100644 --- a/starkbank/corporateholder/log/__log.py +++ b/starkbank/corporateholder/log/__log.py @@ -47,8 +47,8 @@ def query(limit=None, after=None, before=None, types=None, holder_ids=None, ids= Receive a generator of corporateholder.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["created", "blocked"] - holder_ids [list of strings, default None]: list of CorporateHolder ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, holder_id ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["created", "blocked"] - holder_ids [list of strings, default None]: list of CorporateHolder ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/corporateinvoice/__corporateinvoice.py b/starkbank/corporateinvoice/__corporateinvoice.py index 2c1cf1ba..9429bedc 100644 --- a/starkbank/corporateinvoice/__corporateinvoice.py +++ b/starkbank/corporateinvoice/__corporateinvoice.py @@ -64,8 +64,8 @@ def query(limit=None, after=None, before=None, status=None, tags=None, user=None Receive a generator of CorporateInvoice objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [list of strings, default None]: filter for status of retrieved objects. ex: ["created", "expired", "overdue", "paid"] - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call. @@ -90,8 +90,8 @@ def page(cursor=None, limit=None, after=None, before=None, status=None, tags=Non ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [list of strings, default None]: filter for status of retrieved objects. ex: ["created", "expired", "overdue", "paid"] - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call. diff --git a/starkbank/corporatepurchase/__corporatepurchase.py b/starkbank/corporatepurchase/__corporatepurchase.py index 1724fca8..1afcea13 100644 --- a/starkbank/corporatepurchase/__corporatepurchase.py +++ b/starkbank/corporatepurchase/__corporatepurchase.py @@ -101,8 +101,8 @@ def query(ids=None, limit=None, after=None, before=None, merchant_category_types ## Parameters (optional): - ids [list of strings, default None]: purchase IDs - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - merchant_category_types [list of strings, default None]: merchant category type. ex: "health" - holder_ids [list of strings, default None]: card holder IDs. ex: ["5656565656565656", "4545454545454545"] - card_ids [list of strings, default None]: card IDs. ex: ["5656565656565656", "4545454545454545"] @@ -133,8 +133,8 @@ def page(merchant_category_types=None, holder_ids=None, card_ids=None, status=No ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - merchant_category_types [list of strings, default None]: merchant category type. ex: "health" - holder_ids [list of strings, default None]: card holder IDs. ex: ["5656565656565656", "4545454545454545"] - card_ids [list of strings, default None]: card IDs. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/corporatepurchase/log/__log.py b/starkbank/corporatepurchase/log/__log.py index efd4b83e..aa2401be 100644 --- a/starkbank/corporatepurchase/log/__log.py +++ b/starkbank/corporatepurchase/log/__log.py @@ -54,8 +54,8 @@ def query(ids=None, limit=None, after=None, before=None, types=None, purchase_id Receive a generator of corporatepurchase.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["approved", "canceled", "confirmed", "denied", "reversed", "voided"] - purchase_ids [list of strings, default None]: list of Purchase ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - ids [list of strings, default None]: list of CorporatePurchase ids to filter logs. ex: ["5656565656565656", "4545454545454545"] @@ -82,8 +82,8 @@ def page(cursor=None, ids=None, limit=None, after=None, before=None, types=None, ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["approved", "canceled", "confirmed", "denied", "reversed", "voided"] - purchase_ids [list of strings, default None]: list of Purchase ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - ids [list of strings, default None]: list of CorporatePurchase ids to filter logs. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/corporaterule/__corporaterule.py b/starkbank/corporaterule/__corporaterule.py index 1e9a606c..d0b7c9dd 100644 --- a/starkbank/corporaterule/__corporaterule.py +++ b/starkbank/corporaterule/__corporaterule.py @@ -8,10 +8,10 @@ class CorporateRule(Resource): """CorporateRule object The CorporateRule object displays the spending rules of CorporateCards and CorporateHolders created in your Workspace. - # Parameters (required): + ## Parameters (required): - name [string]: rule name. ex: "Travel" or "Food" - amount [integer]: maximum amount that can be spent in the informed interval. ex: 200000 (= R$ 2000.00) - # Parameters (optional): + ## Parameters (optional): - interval [string, default "lifetime"]: interval after which the rule amount counter will be reset to 0. ex: "instant", "day", "week", "month", "year" or "lifetime" - schedule [string, default None]: schedule time for user to spend. ex: "every monday, wednesday from 00:00 to 23:59 in America/Sao_Paulo" - purposes [list of string, default []]: list of strings representing the allowed purposes for card purchases, you can use this to restrict ATM withdrawals. ex: ["purchase", "withdrawal"] @@ -19,7 +19,7 @@ class CorporateRule(Resource): - categories [list of MerchantCategories, default []]: merchant categories accepted by the rule. ex: [MerchantCategory(code="fastFoodRestaurants")] - countries [list of MerchantCountries, default []]: countries accepted by the rule. ex: [MerchantCountry(code="BRA")] - methods [list of CardMethods, default []]: card purchase methods accepted by the rule. ex: [CardMethod(code="magstripe")] - # Attributes (expanded return-only): + ## Attributes (return-only): - id [string]: unique id returned when a CorporateRule is created, used to update a specific CorporateRule. ex: "5656565656565656" - counter_amount [integer]: current rule spent amount. ex: 1000 - currency_symbol [string]: currency symbol. ex: "R$" diff --git a/starkbank/corporatetransaction/__corporatetransaction.py b/starkbank/corporatetransaction/__corporatetransaction.py index 83a7e26d..5e6cdddd 100644 --- a/starkbank/corporatetransaction/__corporatetransaction.py +++ b/starkbank/corporatetransaction/__corporatetransaction.py @@ -50,8 +50,8 @@ def query(source=None, tags=None, external_ids=None, after=None, before=None, ## Parameters (optional): - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - external_ids [list of strings, default None]: external IDs. ex: ["5656565656565656", "4545454545454545"] - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "approved", "canceled", "denied", "confirmed" or "voided" - ids [list of strings, default None]: purchase IDs - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 @@ -82,8 +82,8 @@ def page(source=None, tags=None, external_ids=None, after=None, before=None, - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35 - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - external_ids [list of strings, default None]: external IDs. ex: ["5656565656565656", "4545454545454545"] - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "approved", "canceled", "denied", "confirmed" or "voided" - ids [list of strings, default None]: purchase IDs - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call. diff --git a/starkbank/corporatewithdrawal/__corporatewithdrawal.py b/starkbank/corporatewithdrawal/__corporatewithdrawal.py index a5f74ab5..32a065b8 100644 --- a/starkbank/corporatewithdrawal/__corporatewithdrawal.py +++ b/starkbank/corporatewithdrawal/__corporatewithdrawal.py @@ -9,7 +9,7 @@ class CorporateWithdrawal(Resource): Banking balance. ## Parameters (required): - amount [integer]: CorporateWithdrawal value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34) - - external_id [string] CorporateWithdrawal external ID. ex: "12345" + - external_id [string]: CorporateWithdrawal external ID. ex: "12345" ## Parameters (optional): - tags [list of strings, default []]: list of strings for tagging. ex: ["tony", "stark"] ## Attributes (return-only): @@ -68,8 +68,8 @@ def query(external_ids=None, after=None, before=None, limit=None, tags=None, use ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - external_ids [list of strings, default None]: external IDs. ex: ["5656565656565656", "4545454545454545"] - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call. ## Return: @@ -93,8 +93,8 @@ def page(external_ids=None, after=None, before=None, limit=None, tags=None, curs ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - external_ids [list of strings, default None]: external IDs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call. diff --git a/starkbank/darfpayment/__darfpayment.py b/starkbank/darfpayment/__darfpayment.py index fdf84b13..0fcea1e3 100644 --- a/starkbank/darfpayment/__darfpayment.py +++ b/starkbank/darfpayment/__darfpayment.py @@ -102,8 +102,8 @@ def query(limit=None, after=None, before=None, tags=None, ids=None, status=None, Receive a generator of DarfPayment objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" @@ -130,8 +130,8 @@ def page(cursor=None, limit=None, after=None, before=None, tags=None, ids=None, ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" diff --git a/starkbank/darfpayment/log/__log.py b/starkbank/darfpayment/log/__log.py index 6cb938c7..f0230f06 100644 --- a/starkbank/darfpayment/log/__log.py +++ b/starkbank/darfpayment/log/__log.py @@ -48,8 +48,8 @@ def query(limit=None, after=None, before=None, types=None, payment_ids=None, use Receive a generator of darfpayment.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - payment_ids [list of strings, default None]: list of DarfPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Project object, default None]: Project object. Not necessary if starkbank.user was set before function call @@ -74,8 +74,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, payment_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by types. ex: "success" or "failed" - payment_ids [list of strings, default None]: list of TaxPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/deposit/__deposit.py b/starkbank/deposit/__deposit.py index 0e609a79..9ff253f0 100644 --- a/starkbank/deposit/__deposit.py +++ b/starkbank/deposit/__deposit.py @@ -66,8 +66,8 @@ def query(limit=None, after=None, before=None, status=None, sort=None, tags=None Receive a generator of Deposit objects from the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "paid" or "registered" - sort [string, default "-created"]: sort order considered in response. Valid options are "created" or "-created". - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] @@ -96,8 +96,8 @@ def page(cursor=None, limit=None, after=None, before=None, status=None, sort=Non ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "paid" or "registered" - sort [string, default "-created"]: sort order considered in response. Valid options are "created" or "-created". - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] diff --git a/starkbank/deposit/log/__log.py b/starkbank/deposit/log/__log.py index 5c6de593..aceaabed 100644 --- a/starkbank/deposit/log/__log.py +++ b/starkbank/deposit/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, after=None, before=None, types=None, deposit_ids=None, use Receive a generator of deposit.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: "created" or "credited" - deposit_ids [list of strings, default None]: list of Deposit ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, deposit_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: "created" or "credited" - deposit_ids [list of strings, default None]: list of Deposit ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/dictkey/__dictkey.py b/starkbank/dictkey/__dictkey.py index 6208d02b..0808d343 100644 --- a/starkbank/dictkey/__dictkey.py +++ b/starkbank/dictkey/__dictkey.py @@ -61,8 +61,8 @@ def query(limit=None, type=None, after=None, before=None, ids=None, status=None, ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - type [string, default None]: DictKey type. ex: "cpf", "cnpj", "phone", "email" or "evp" - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -89,8 +89,8 @@ def page(cursor=None, limit=None, type=None, after=None, before=None, ids=None, - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - type [string, default None]: DictKey type. ex: "cpf", "cnpj", "phone", "email" or "evp" - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/event/attempt/__attempt.py b/starkbank/event/attempt/__attempt.py index 9c63600d..31362d77 100644 --- a/starkbank/event/attempt/__attempt.py +++ b/starkbank/event/attempt/__attempt.py @@ -47,8 +47,8 @@ def query(limit=None, after=None, before=None, event_ids=None, webhook_ids=None, Receive a generator of event.Attempt objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - event_ids [list of strings, default None]: list of Event ids to filter attempts. ex: ["5656565656565656", "4545454545454545"] - webhook_ids [list of strings, default None]: list of Webhook ids to filter attempts. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -73,8 +73,8 @@ def page(cursor=None, limit=None, after=None, before=None, event_ids=None, webho ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - event_ids [list of strings, default None]: list of Event ids to filter attempts. ex: ["5656565656565656", "4545454545454545"] - webhook_ids [list of strings, default None]: list of Webhook ids to filter attempts. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/invoice/__invoice.py b/starkbank/invoice/__invoice.py index 971f6349..f2e33418 100644 --- a/starkbank/invoice/__invoice.py +++ b/starkbank/invoice/__invoice.py @@ -135,8 +135,8 @@ def query(limit=None, status=None, tags=None, ids=None, after=None, before=None, Receive a generator of Invoice objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "paid" or "registered" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -163,8 +163,8 @@ def page(cursor=None, limit=None, status=None, tags=None, ids=None, after=None, ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "paid" or "registered" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/invoice/log/__log.py b/starkbank/invoice/log/__log.py index fbd7af8c..207130d2 100644 --- a/starkbank/invoice/log/__log.py +++ b/starkbank/invoice/log/__log.py @@ -48,8 +48,8 @@ def query(limit=None, after=None, before=None, types=None, invoice_ids=None, use Receive a generator of invoice.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: "paid" or "registered" - invoice_ids [list of strings, default None]: list of Invoice ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -74,8 +74,8 @@ def page(cursor=None, after=None, before=None, types=None, invoice_ids=None, lim ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: "paid" or "registered" - invoice_ids [list of strings, default None]: list of Invoice ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/invoicepullrequest/__invoicepullrequest.py b/starkbank/invoicepullrequest/__invoicepullrequest.py index 69b29c13..d1471eef 100644 --- a/starkbank/invoicepullrequest/__invoicepullrequest.py +++ b/starkbank/invoicepullrequest/__invoicepullrequest.py @@ -78,8 +78,8 @@ def query(limit=None, status=None, invoice_ids=None, subscription_ids=None, exte Receive a generator of InvoicePullRequest objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [list of strings, default None]: filter for status of retrieved objects. ex: ["success", "failed"] - invoice_ids [list of strings, default None]: list of Invoice ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - subscription_ids [list of strings, default None]: list of InvoicePullSubscription ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -113,8 +113,8 @@ def page(cursor=None, limit=None, status=None, invoice_ids=None, subscription_id ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [list of strings, default None]: filter for status of retrieved objects. ex: ["success", "failed"] - invoice_ids [list of strings, default None]: list of Invoice ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - subscription_ids [list of strings, default None]: list of InvoicePullSubscription ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/invoicepullrequest/log/__log.py b/starkbank/invoicepullrequest/log/__log.py index d83a6596..fcbf0f87 100644 --- a/starkbank/invoicepullrequest/log/__log.py +++ b/starkbank/invoicepullrequest/log/__log.py @@ -48,8 +48,8 @@ def query(limit=None, after=None, before=None, types=None, request_ids=None, use Receive a generator of invoicepullrequest.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["success" or "failed"] - request_ids [list of strings, default None]: list of InvoicePullRequest ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -74,8 +74,8 @@ def page(cursor=None, after=None, before=None, types=None, request_ids=None, lim ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["success" or "failed"] - request_ids [list of strings, default None]: list of InvoicePullRequest ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/invoicepullsubscription/__invoicepullsubscription.py b/starkbank/invoicepullsubscription/__invoicepullsubscription.py index 6ee2bace..5b05b408 100644 --- a/starkbank/invoicepullsubscription/__invoicepullsubscription.py +++ b/starkbank/invoicepullsubscription/__invoicepullsubscription.py @@ -99,8 +99,8 @@ def query(limit=None, status=None, invoice_ids=None, external_ids=None, tags=Non Receive a generator of InvoicePullSubscription objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [list of strings, default None]: filter for status of retrieved objects. ex: ["active", "canceled"] - invoice_ids [list of strings, default None]: list of Invoice ids linked to the subscriptions. ex: ["5656565656565656", "4545454545454545"] - external_ids [list of strings, default None]: list of external_ids to filter retrieved objects. ex: ["my-external-id-1", "my-external-id-2"] @@ -132,8 +132,8 @@ def page(cursor=None, limit=None, status=None, invoice_ids=None, external_ids=No ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [list of strings, default None]: filter for status of retrieved objects. ex: ["active", "canceled"] - invoice_ids [list of strings, default None]: list of Invoice ids linked to the subscriptions. ex: ["5656565656565656", "4545454545454545"] - external_ids [list of strings, default None]: list of external_ids to filter retrieved objects. ex: ["my-external-id-1", "my-external-id-2"] diff --git a/starkbank/invoicepullsubscription/log/__log.py b/starkbank/invoicepullsubscription/log/__log.py index c138f729..badc7a5e 100644 --- a/starkbank/invoicepullsubscription/log/__log.py +++ b/starkbank/invoicepullsubscription/log/__log.py @@ -48,8 +48,8 @@ def query(limit=None, after=None, before=None, types=None, subscription_ids=None Receive a generator of invoicepullsubscription.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["active" or "canceled"] - subscription_ids [list of strings, default None]: list of InvoicePullSubscription ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -74,8 +74,8 @@ def page(cursor=None, after=None, before=None, types=None, subscription_ids=None ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter for log event types. ex: ["active" or "canceled"] - subscription_ids [list of strings, default None]: list of InvoicePullSubscription ids to filter logs. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/merchantcard/__merchantcard.py b/starkbank/merchantcard/__merchantcard.py index 279c5a43..3421db53 100644 --- a/starkbank/merchantcard/__merchantcard.py +++ b/starkbank/merchantcard/__merchantcard.py @@ -6,10 +6,16 @@ class MerchantCard(Resource): """# MerchantCard object Stores information about a card used in an approved purchase, so it can be reused in new purchases without a new MerchantSession. ## Attributes (return-only): - - id, ending, funding_type, holder_name, network [string] + - id [string]: + - ending [string]: + - funding_type [string]: + - holder_name [string]: + - network [string]: - status [string]: current status. ex: "active", "expired", "canceled" or "blocked" - - tags [list of strings] - - expiration, created, updated [datetime] + - tags [list of strings]: + - expiration [datetime]: + - created [datetime]: + - updated [datetime]: """ def __init__(self, id=None, ending=None , funding_type=None, holder_name=None, network=None, status=None, tags=None, @@ -47,8 +53,8 @@ def query(limit=None, after=None, before=None, status=None, tags=None, ids=None, Receive a generator of MerchantCard objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "active" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -75,8 +81,8 @@ def page(cursor=None, limit=None, after=None, before=None, status=None, tags=Non ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "active" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/merchantcard/log/__log.py b/starkbank/merchantcard/log/__log.py index 6413e815..a15e133e 100644 --- a/starkbank/merchantcard/log/__log.py +++ b/starkbank/merchantcard/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, card_ids=None, after=None, before=None, user=None, types=N ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - card_ids [list of strings, default None]: list of MerchantCard ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: ["created", "updated"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call ## Return: @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, card_ids=None, after=None, before=None, user=N - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - card_ids [list of strings, default None]: list of MerchantCard ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: ["created", "updated"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call ## Return: diff --git a/starkbank/merchantinstallment/__merchantinstallment.py b/starkbank/merchantinstallment/__merchantinstallment.py index 99a325f3..193698e9 100644 --- a/starkbank/merchantinstallment/__merchantinstallment.py +++ b/starkbank/merchantinstallment/__merchantinstallment.py @@ -59,8 +59,8 @@ def query(limit=None, after=None, before=None, status=None, tags=None, ids=None, Receive a generator of MerchantInstallment objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "success" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -89,8 +89,8 @@ def page(cursor=None, limit=None, after=None, before=None, status=None, tags=Non ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "success" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/merchantinstallment/log/__log.py b/starkbank/merchantinstallment/log/__log.py index 3740da06..e6c79c41 100644 --- a/starkbank/merchantinstallment/log/__log.py +++ b/starkbank/merchantinstallment/log/__log.py @@ -48,8 +48,8 @@ def query(limit=None, after=None, before=None, types=None, user=None, installmen Receive a generator of MerchantInstallmentLog objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: ["created", "updated"] - installment_ids [list of strings, default None]: list of MerchantInstallment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -74,8 +74,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, user=None ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: ["created", "updated"] - installment_ids [list of strings, default None]: list of MerchantInstallment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/merchantpurchase/__merchantpurchase.py b/starkbank/merchantpurchase/__merchantpurchase.py index eb415310..f9633feb 100644 --- a/starkbank/merchantpurchase/__merchantpurchase.py +++ b/starkbank/merchantpurchase/__merchantpurchase.py @@ -14,8 +14,19 @@ class MerchantPurchase(Resource): - funding_type [string]: type of funding used. ex: "credit", "debit" - installment_count [integer]: number of installments the purchase is split into. ex: 1 ## Parameters (optional): - - card_expiration, card_number, card_security_code, holder_name, holder_email, holder_phone, holder_id [string, default None]: card and holder data, required only when not created through a MerchantSession. - - billing_country_code, billing_city, billing_state_code, billing_street_line_1, billing_street_line_2, billing_zip_code [string, default None]: billing address data. + - card_expiration [string, default None]: card and holder data, required only when not created through a MerchantSession. + - card_number [string, default None]: card and holder data, required only when not created through a MerchantSession. + - card_security_code [string, default None]: card and holder data, required only when not created through a MerchantSession. + - holder_name [string, default None]: card and holder data, required only when not created through a MerchantSession. + - holder_email [string, default None]: card and holder data, required only when not created through a MerchantSession. + - holder_phone [string, default None]: card and holder data, required only when not created through a MerchantSession. + - holder_id [string, default None]: card and holder data, required only when not created through a MerchantSession. + - billing_country_code [string, default None]: billing address data. + - billing_city [string, default None]: billing address data. + - billing_state_code [string, default None]: billing address data. + - billing_street_line_1 [string, default None]: billing address data. + - billing_street_line_2 [string, default None]: billing address data. + - billing_zip_code [string, default None]: billing address data. - metadata [dictionary, default None]: additional 3DS metadata sent by the merchant's browser/app. - soft_descriptor [string, default None]: text that will be shown in the holder's bank statement. ex: "my-store" - tags [list of strings, default None]: list of strings for tagging @@ -109,8 +120,8 @@ def query(limit=None, after=None, before=None, status=None, tags=None, ids=None, Receive a generator of MerchantPurchase objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "approved" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -139,8 +150,8 @@ def page(cursor=None, limit=None, after=None, before=None, status=None, tags=Non ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - status [string, default None]: filter for status of retrieved objects. ex: "approved" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -172,7 +183,7 @@ def update(id, status=None, amount=None, user=None): ## Parameters (optional): - status [string, default None]: "canceled" or "reversed", per the rules above. - amount [integer, default None]: new amount; 0 to cancel an approved purchase, or a lower value to partially/fully reverse a confirmed one. - - user [Organization/Project object, default None]. + - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call ## Return: - target MerchantPurchase with updated attributes """ diff --git a/starkbank/merchantpurchase/log/__log.py b/starkbank/merchantpurchase/log/__log.py index cc248dc5..a9eb9ff3 100644 --- a/starkbank/merchantpurchase/log/__log.py +++ b/starkbank/merchantpurchase/log/__log.py @@ -47,8 +47,8 @@ def query(limit=None, after=None, before=None, types=None, user=None, purchase_i Receive a generator of MerchantPurchaseLog objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: ["created", "updated"] - purchase_ids [list of strings, default None]: list of MerchantPurchase ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -72,8 +72,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, user=None ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: ["created", "updated"] - purchase_ids [list of strings, default None]: list of MerchantPurchase ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/merchantsession/__merchantsession.py b/starkbank/merchantsession/__merchantsession.py index 67f8dae8..8d622475 100644 --- a/starkbank/merchantsession/__merchantsession.py +++ b/starkbank/merchantsession/__merchantsession.py @@ -96,8 +96,8 @@ def query(limit=None, status=None, tags=None, ids=None, after=None, before=None, - status [string, default None]: filter for status of retrieved objects. ex: "created" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - holder_id [string, default None]: filter for sessions belonging to a specific card holder. ex: "5656565656565656" - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call ## Return: @@ -126,8 +126,8 @@ def page(cursor=None, limit=None, status=None, tags=None, ids=None, after=None, - status [string, default None]: filter for status of retrieved objects. ex: "created" - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - holder_id [string, default None]: filter for sessions belonging to a specific card holder. ex: "5656565656565656" - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call ## Return: diff --git a/starkbank/merchantsession/__purchase.py b/starkbank/merchantsession/__purchase.py index c6490074..367b90c4 100644 --- a/starkbank/merchantsession/__purchase.py +++ b/starkbank/merchantsession/__purchase.py @@ -5,6 +5,41 @@ class Purchase(Resource): """# Purchase object Check out our API Documentation at https://starkbank.com/docs/api#merchant-session + ## Parameters (required): + - amount [integer]: Purchase value in cents. ex: 1234 (= R$ 12.34) + - card_expiration [string]: expiration of the card used for the purchase, in the format YYYY-MM. ex: "2032-12" + - card_number [string]: number of the card used for the purchase. + - card_security_code [string]: security code of the card used for the purchase. + - holder_name [string]: card holder name. ex: "Tony Stark" + - funding_type [string]: type of funding used for the purchase. ex: "credit", "debit" + ## Parameters (optional): + - holder_email [string, default None]: email associated with the card holder, required if the session's challenge_mode is "enabled" and optional otherwise. + - holder_phone [string, default None]: phone number associated with the card holder, required if the session's challenge_mode is "enabled" and optional otherwise. + - holder_id [string, default None]: additional card holder identification data. + - installment_count [integer, default None]: number of installments the purchase is split into. ex: 1 + - billing_country_code [string, default None]: billing country code associated with the card used for the purchase, required if the session's challenge_mode is "enabled" and optional otherwise. + - billing_city [string, default None]: billing city associated with the card used for the purchase, required if the session's challenge_mode is "enabled" and optional otherwise. + - billing_state_code [string, default None]: billing state code associated with the card used for the purchase, required if the session's challenge_mode is "enabled" and optional otherwise. + - billing_street_line_1 [string, default None]: billing street address associated with the card used for the purchase, required if the session's challenge_mode is "enabled" and optional otherwise. + - billing_street_line_2 [string, default None]: billing street address complement associated with the card used for the purchase, required if the session's challenge_mode is "enabled" and optional otherwise. + - billing_zip_code [string, default None]: billing zip code associated with the card used for the purchase, required if the session's challenge_mode is "enabled" and optional otherwise. + - metadata [dictionary, default None]: additional data related to the purchase. If 3DS is enabled, the following fields related to the payer's device are required: userAgent, timezoneOffset, userIp, language. + - soft_descriptor [string, default None]: text that will be shown in the holder's bank statement. ex: "my-store" + - tags [list of strings, default None]: list of strings for tagging + ## Attributes (return-only): + - id [string]: unique id returned when a Purchase is created. ex: "5656565656565656" + - card_ending [string]: last 4 digits of the card used. ex: "1234" + - card_id [string]: unique id of the MerchantCard used for the purchase. ex: "5656565656565656" + - challenge_mode [string]: whether 3DS holder verification was used. ex: "enabled", "disabled" + - challenge_url [string]: URL to the 3DS challenge, when applicable. + - created [datetime.datetime]: creation datetime for the Purchase. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0) + - currency_code [string]: currency of the purchase. ex: "BRL" + - end_to_end_id [string]: unique transaction id for the acquirer network. + - fee [integer]: fee charged when the Purchase is processed. ex: 200 (= R$ 2.00) + - network [string]: card network flag. ex: "visa", "mastercard" + - source [string]: locator of the entity that generated the purchase. ex: "merchant-session/{sessionId}" + - status [string]: current Purchase status. ex: "approved", "confirmed", "canceled", "voided" + - updated [datetime.datetime]: latest update datetime for the Purchase. ex: datetime.datetime(2020, 3, 10, 10, 30, 0, 0) """ def __init__(self, amount, card_expiration, card_number, card_security_code, holder_name, funding_type, id=None, diff --git a/starkbank/merchantsession/log/__log.py b/starkbank/merchantsession/log/__log.py index 15751d0e..39ddb9df 100644 --- a/starkbank/merchantsession/log/__log.py +++ b/starkbank/merchantsession/log/__log.py @@ -46,8 +46,8 @@ def query(limit=None, after=None, before=None, types=None, session_ids=None, use Receive a generator of MerchantSessionLog objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: ["created", "updated"] - session_ids [list of strings, default None]: list of MerchantSession ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -72,8 +72,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, session_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: ["created", "updated"] - session_ids [list of strings, default None]: list of MerchantSession ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/split/__split.py b/starkbank/split/__split.py index 38ee6896..3d959ef1 100644 --- a/starkbank/split/__split.py +++ b/starkbank/split/__split.py @@ -59,8 +59,8 @@ def query(limit=None, after=None, before=None, tags=None, ids=None, receiver_ids Receive a generator of Split objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - receiver_ids [list of strings, default None]: list of receiver ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -89,8 +89,8 @@ def page(cursor=None, after=None, before=None, tags=None, ids=None, receiver_ids ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - receiver_ids [list of strings, default None]: list of receiver ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/split/log/__log.py b/starkbank/split/log/__log.py index 3dc49203..2b4a211c 100644 --- a/starkbank/split/log/__log.py +++ b/starkbank/split/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, after=None, before=None, types=None, split_ids=None, user= Receive a generator of split.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - split_ids [list of strings, default None]: list of Split ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, split_ids ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - split_ids [list of strings, default None]: list of Split ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/splitprofile/__splitprofile.py b/starkbank/splitprofile/__splitprofile.py index b5f22672..dc4ccb74 100644 --- a/starkbank/splitprofile/__splitprofile.py +++ b/starkbank/splitprofile/__splitprofile.py @@ -85,8 +85,8 @@ def page(cursor=None, after=None, before=None, tags=None, ids=None, receiver_ids ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" diff --git a/starkbank/splitprofile/log/__log.py b/starkbank/splitprofile/log/__log.py index 460040cf..3e7d8295 100644 --- a/starkbank/splitprofile/log/__log.py +++ b/starkbank/splitprofile/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, after=None, before=None, types=None, profile_ids=None, use Receive a generator of SplitProfile.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "created" or "updated" - profile_ids [list of strings, default None]: list of SplitProfile ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, profile_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "created" or "updated" - profile_ids [list of strings, default None]: list of SplitProfile ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/splitreceiver/log/__log.py b/starkbank/splitreceiver/log/__log.py index 70b6f3b2..8679d8d5 100644 --- a/starkbank/splitreceiver/log/__log.py +++ b/starkbank/splitreceiver/log/__log.py @@ -49,8 +49,8 @@ def query(limit=None, after=None, before=None, types=None, receiver_ids=None, us Receive a generator of splitreceiver.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - receiver_ids [list of strings, default None]: list of splitreceiver ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -75,8 +75,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, receiver_ ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - receiver_ids [list of strings, default None]: list of splitreceiver ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/taxpayment/__taxpayment.py b/starkbank/taxpayment/__taxpayment.py index a4258f16..6649d3d8 100644 --- a/starkbank/taxpayment/__taxpayment.py +++ b/starkbank/taxpayment/__taxpayment.py @@ -93,8 +93,8 @@ def query(limit=None, after=None, before=None, tags=None, ids=None, status=None, Receive a generator of TaxPayment objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" @@ -121,8 +121,8 @@ def page(cursor=None, limit=None, after=None, before=None, tags=None, ids=None, ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" diff --git a/starkbank/taxpayment/log/__log.py b/starkbank/taxpayment/log/__log.py index edbe4544..f63f6038 100644 --- a/starkbank/taxpayment/log/__log.py +++ b/starkbank/taxpayment/log/__log.py @@ -48,8 +48,8 @@ def query(limit=None, after=None, before=None, types=None, payment_ids=None, use Receive a generator of taxpayment.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - payment_ids [list of strings, default None]: list of TaxPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Project object, default None]: Project object. Not necessary if starkbank.user was set before function call @@ -74,8 +74,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, payment_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by types. ex: "success" or "failed" - payment_ids [list of strings, default None]: list of TaxPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/transaction/__transaction.py b/starkbank/transaction/__transaction.py index 8ff9958c..f650a5cc 100644 --- a/starkbank/transaction/__transaction.py +++ b/starkbank/transaction/__transaction.py @@ -73,8 +73,8 @@ def query(limit=None, after=None, before=None, tags=None, external_ids=None, ids Use this function instead of page if you want to stream Transactions without worrying about cursors and pagination. ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - external_ids [list of strings, default None]: list of external ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] @@ -101,8 +101,8 @@ def page(cursor=None, limit=None, after=None, before=None, tags=None, external_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - external_ids [list of strings, default None]: list of external ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] diff --git a/starkbank/transfer/log/__log.py b/starkbank/transfer/log/__log.py index 16ad6837..170f8ca5 100644 --- a/starkbank/transfer/log/__log.py +++ b/starkbank/transfer/log/__log.py @@ -47,8 +47,8 @@ def query(limit=None, after=None, before=None, types=None, transfer_ids=None, us Receive a generator of transfer.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by types. ex: "success" or "failed" - transfer_ids [list of strings, default None]: list of Transfer ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -73,8 +73,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, transfer_ ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by types. ex: "success" or "failed" - transfer_ids [list of strings, default None]: list of Transfer ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call diff --git a/starkbank/utilitypayment/__utilitypayment.py b/starkbank/utilitypayment/__utilitypayment.py index 4891b3e7..5839c312 100644 --- a/starkbank/utilitypayment/__utilitypayment.py +++ b/starkbank/utilitypayment/__utilitypayment.py @@ -93,8 +93,8 @@ def query(limit=None, after=None, before=None, tags=None, ids=None, status=None, Receive a generator of UtilityPayment objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" @@ -121,8 +121,8 @@ def page(cursor=None, limit=None, after=None, before=None, tags=None, ids=None, ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - tags [list of strings, default None]: tags to filter retrieved objects. ex: ["tony", "stark"] - ids [list of strings, default None]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - status [string, default None]: filter for status of retrieved objects. ex: "success" diff --git a/starkbank/utilitypayment/log/__log.py b/starkbank/utilitypayment/log/__log.py index c7255ab0..5aea695c 100644 --- a/starkbank/utilitypayment/log/__log.py +++ b/starkbank/utilitypayment/log/__log.py @@ -48,8 +48,8 @@ def query(limit=None, after=None, before=None, types=None, payment_ids=None, use Receive a generator of utilitypayment.Log objects previously created in the Stark Bank API ## Parameters (optional): - limit [integer, default None]: maximum number of objects to be retrieved. Unlimited if None. ex: 35 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - payment_ids [list of strings, default None]: list of UtilityPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call @@ -74,8 +74,8 @@ def page(cursor=None, limit=None, after=None, before=None, types=None, payment_i ## Parameters (optional): - cursor [string, default None]: cursor returned on the previous page function call - limit [integer, default 100]: maximum number of objects to be retrieved. It must be an integer between 1 and 100. ex: 50 - - after [datetime.date or string, default None] date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) - - before [datetime.date or string, default None] date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) + - after [datetime.date or string, default None]: date filter for objects created only after specified date. ex: datetime.date(2020, 3, 10) + - before [datetime.date or string, default None]: date filter for objects created only before specified date. ex: datetime.date(2020, 3, 10) - types [list of strings, default None]: filter retrieved objects by event types. ex: "processing" or "success" - payment_ids [list of strings, default None]: list of UtilityPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"] - user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkbank.user was set before function call From d3a9d79b95e3d96d1b6350f7276f364d500026ff Mon Sep 17 00:00:00 2001 From: edu-stark Date: Wed, 16 Sep 2026 14:36:11 -0300 Subject: [PATCH 2/2] ci: run offline checks on pull requests and the sandbox suite on a schedule The one workflow ran the sandbox suite on every pull request, and that suite has failed on every run since May 2026 for reasons no change can fix (the CI workspace is blocked, the runner IP is not allowed), so every PR showed red and the check stopped meaning anything. Pull requests now get what can pass without a live workspace - compileall, an import, flake8's syntax and undefined-name selection - and the sandbox suite keeps its secrets and runs weekly or on demand. Co-Authored-By: Claude Opus 5 (1M context) --- .github/workflows/python-app.yml | 27 +++++++++---------- .github/workflows/sandbox-suite.yml | 41 +++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 15 deletions(-) create mode 100644 .github/workflows/sandbox-suite.yml diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml index 84b67bdb..400d87e6 100644 --- a/.github/workflows/python-app.yml +++ b/.github/workflows/python-app.yml @@ -1,5 +1,6 @@ -# This workflow will install Python dependencies, run tests and lint with a single version of Python -# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python +# Pull requests get the checks that can pass without a live workspace. The +# sandbox suite needs the CI project's credentials and an allowed IP, so it +# runs on a schedule in sandbox-suite.yml instead of blocking every review. name: Python application @@ -12,29 +13,25 @@ on: permissions: contents: read -env: - SANDBOX_CENTER_ID: ${{ secrets.SANDBOX_CENTER_ID }} - SANDBOX_ID: ${{ secrets.SANDBOX_ID }} - SANDBOX_ORGANIZATION_ID: ${{ secrets.SANDBOX_ORGANIZATION_ID }} - SANDBOX_ORGANIZATION_PRIVATE_KEY: ${{ secrets.SANDBOX_ORGANIZATION_PRIVATE_KEY }} - SANDBOX_PRIVATE_KEY: ${{ secrets.SANDBOX_PRIVATE_KEY }} - jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python 3.10 - uses: actions/setup-python@v3 + uses: actions/setup-python@v5 with: python-version: "3.10" - name: Install dependencies run: | python -m pip install --upgrade pip - pip install flake8 pytest + pip install flake8 if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - - name: Test with pytest - run: | - pytest + - name: Compile every module + run: python -m compileall -q starkbank tests + - name: Import the package + run: python -c "import starkbank" + - name: Syntax errors and undefined names + run: flake8 starkbank --count --select=E9,F63,F7,F82 --show-source --statistics diff --git a/.github/workflows/sandbox-suite.yml b/.github/workflows/sandbox-suite.yml new file mode 100644 index 00000000..0e40ec92 --- /dev/null +++ b/.github/workflows/sandbox-suite.yml @@ -0,0 +1,41 @@ +# The full suite runs against the sandbox with the CI project's credentials. +# It is scheduled rather than tied to pull requests: it has failed on every +# run since May 2026 (blocked workspace, runner IP not allowed) and a red +# check that no change can turn green tells a reviewer nothing. + +name: Sandbox suite + +on: + schedule: + - cron: "0 9 * * 1" + workflow_dispatch: + +permissions: + contents: read + +env: + SANDBOX_CENTER_ID: ${{ secrets.SANDBOX_CENTER_ID }} + SANDBOX_ID: ${{ secrets.SANDBOX_ID }} + SANDBOX_ORGANIZATION_ID: ${{ secrets.SANDBOX_ORGANIZATION_ID }} + SANDBOX_ORGANIZATION_PRIVATE_KEY: ${{ secrets.SANDBOX_ORGANIZATION_PRIVATE_KEY }} + SANDBOX_PRIVATE_KEY: ${{ secrets.SANDBOX_PRIVATE_KEY }} + +jobs: + sandbox: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - name: Set up Python 3.10 + uses: actions/setup-python@v5 + with: + python-version: "3.10" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pytest + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Test with pytest + run: | + pytest