Skip to content

Commit

Permalink
Fix null and None docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
cdottori-stark committed Jan 21, 2021
1 parent 3f0eb60 commit d99b22f
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion lib/boleto_payment/boleto_payment.ex
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ defmodule StarkBank.BoletoPayment do
- `:after` [Date or string, default nil]: date filter for structs created only after specified date. ex: ~D[2020-03-25]
- `:before` [Date or string, default nil]: date filter for structs created only before specified date. ex: ~D[2020-03-25]
- `:tags` [list of strings, default nil]: tags to filter retrieved structs. ex: ["tony", "stark"]
- `:ids` [list of strings, default null]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
- `:ids` [list of strings, default nil]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
- `:status` [string, default nil]: filter for status of retrieved structs. ex: "paid"
- `:user` [Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Expand Down
4 changes: 2 additions & 2 deletions lib/brcode_payment/brcode_payment.ex
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ defmodule StarkBank.BrcodePayment do
- `:id` [string, default nil]: unique id returned when payment is created. ex: "5656565656565656"
- `:name` [string, default nil]: receiver name. ex: "Jon Snow"
- `:status` [string, default nil]: current payment status. ex: "success" or "failed"
- `:type` [string, default null]: brcode type. ex: "static" or "dynamic"
- `:type` [string, default nil]: brcode type. ex: "static" or "dynamic"
- `:fee` [integer, default nil]: fee charged when a brcode payment is created. ex: 200 (= R$ 2.00)
- `:created` [DateTime, default nil]: creation datetime for the payment. ex: ~U[2020-03-26 19:32:35.418698Z]
- `:updated` [DateTime, default nil]: latest update datetime for the Deposit. ex: ~U[2020-08-20 19:32:35.418698Z]
Expand Down Expand Up @@ -147,7 +147,7 @@ defmodule StarkBank.BrcodePayment do
- `:after` [Date or string, default nil]: date filter for structs created only after specified date. ex: ~D[2020-03-25]
- `:before` [Date or string, default nil]: date filter for structs created only before specified date. ex: ~D[2020-03-25]
- `:tags` [list of strings, default nil]: tags to filter retrieved structs. ex: ["tony", "stark"]
- `:ids` [list of strings, default null]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
- `:ids` [list of strings, default nil]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
- `:status` [string, default nil]: filter for status of retrieved structs. ex: "paid"
- `:user` [Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Expand Down
6 changes: 3 additions & 3 deletions lib/dict_key/dict_key.ex
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ defmodule StarkBank.DictKey do
- `:account_type` [string, default nil]: bank account type associated with the DICT key. ex: "checking", "saving" e "salary"
- `:status` [string, default nil]: current DICT key status. ex: "created", "registered", "canceled" or "failed"
- `:account_created` [datetime.datetime, default nil]: creation datetime of the bank account associated with the DICT key. ex: datetime.date(2020, 1, 12, 11, 14, 8)
- `:owned` [DateTime, default null]: datetime since when the current owner hold this DICT key. ex: ~U[2020-11-26 17:31:45.482618Z]
- `:created` [DateTime, default null]: creation datetime for the DICT key. ex: ~U[2020-11-26 17:31:45.482618Z]
- `:owned` [DateTime, default nil]: datetime since when the current owner hold this DICT key. ex: ~U[2020-11-26 17:31:45.482618Z]
- `:created` [DateTime, default nil]: creation datetime for the DICT key. ex: ~U[2020-11-26 17:31:45.482618Z]
"""
defstruct [
:id,
Expand Down Expand Up @@ -81,7 +81,7 @@ defmodule StarkBank.DictKey do
- `:type` [string, default nil]: DictKey type. ex: "cpf", "cnpj", "phone", "email" or "evp"
- `:after` [Date or string, default nil]: date filter for structs created only after specified date. ex: ~D[2020-03-25]
- `:before` [Date or string, default nil]: date filter for structs created only before specified date. ex: ~D[2020-03-25]
- `:ids` [list of strings, default null]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
- `:ids` [list of strings, default nil]: list of ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
- `:status` [string, default nil]: filter for status of retrieved structs. ex: "registered"
- `:user` [Organization/Project]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Expand Down
2 changes: 1 addition & 1 deletion lib/starkbank.ex
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ defmodule StarkBank do
- `:private_key` [EllipticCurve.Organization()]: PEM string of the private key linked to the organization. ex: "-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----"
## Parameters (optional):
- `:workspace_id` [string]: unique id of the accessed Workspace, if any. ex: None or "4848484848484848"
- `:workspace_id` [string]: unique id of the accessed Workspace, if any. ex: nil or "4848484848484848"
"""
@spec organization(
environment: :production | :sandbox,
Expand Down
2 changes: 1 addition & 1 deletion lib/transfer/transfer.ex
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ defmodule StarkBank.Transfer do
## Parameters (optional):
- `:account_type` [string, default "checking"]: Receiver bank account type. This parameter only has effect on Pix Transfers. ex: "checking", "savings" or "salary"
- `:external_id` [string, default null]: url safe string that must be unique among all your transfers. Duplicated external_ids will cause failures. By default, this parameter will block any transfer that repeats amount and receiver information on the same date. ex: "my-internal-id-123456"
- `:external_id` [string, default nil]: url safe string that must be unique among all your transfers. Duplicated external_ids will cause failures. By default, this parameter will block any transfer that repeats amount and receiver information on the same date. ex: "my-internal-id-123456"
- `:scheduled` [Date, DateTime or string, default now]: date or datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: ~U[2020-03-26 19:32:35.418698Z]
- `:tags` [list of strings]: list of strings for reference when searching for transfers. ex: ["employees", "monthly"]
Expand Down
2 changes: 1 addition & 1 deletion lib/workspace/workspace.ex
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ defmodule StarkBank.Workspace do
- `:name` [string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: "Stark Bank Workspace"
## Attributes (return-only):
- `:id` [string, default None]: unique id returned when the workspace is created. ex: "5656565656565656"
- `:id` [string, default nil]: unique id returned when the workspace is created. ex: "5656565656565656"
"""
@enforce_keys [
:username,
Expand Down

0 comments on commit d99b22f

Please sign in to comment.