All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to the following versioning pattern:
Given a version number MAJOR.MINOR.PATCH, increment:
- MAJOR version when the API version is incremented. This may include backwards incompatible changes;
- MINOR version when breaking changes are introduced OR new functionalities are added in a backwards compatible manner;
- PATCH version when backwards compatible bug fixes are implemented.
- merchantSession and merchantPurchase README.md
- merchantSession tests
- merchantSession required parameters
- types to merchantSession and merchantPurchase resources
- request methods to typescript
- query and get methods to merchantSession resource
- merchantPurchase log
- query and get methods to merchantPurchase resource
- merchantSession and merchantSessionPurchase resources
- core version
- request methods
- core version
- core version to v0.0.5
- MerchantCategory subResource import
- displayDescription parameter to transfer, invoice and deposit resources
- tags types parameter reference
- optional parameters types
- core version to v0.0.4
- user export to rest resource
- internal structure to use starkcore as a dependency
- sdk version
- update types to Deposit resource
- Readme Deposit resource
- update function to Deposit resource
- accountCreated, created and owned attributes to DictKey resource
- accountNumber and branchCode attributes to PaymentPreview resource
- accountNumber and branchCode attributes to DictKey resource
- accountType docstring attribute to DictKey resource
- rules types to Invoice resource
- Rule object types
- CorporateBalance resource
- CorporateCard resource
- CorporateHolder resource
- CorporateInvoice resource
- CorporatePurchase resource
- CorporateRule resource
- CorporateTransaction resource
- CorporateWithdrawal resource
- Invoice resource
- pdf function on boletoPayment, darfPayment, invoice, invoice.Log, taxPayment, transfer and utilityPayment
- metadata attribute to Transfer resource
- missing parameters to the SDK resources
- status, organizationId, created and pictureUrl attribute to Workspace resource
- status parameter to update method on Workspace resource
- workspaceId attribute to Boleto resource
- description attribute to PaymentRequest resource
- updated attribute to BoletoHolmes.Log resource
- updated and type attribute to UtilityPayment resource
- deprecated BrcodePreview resource
- pictureUrl attribute to DynamicBrcode resource
- BrcodePayment.Rule type on BrcodePayment resource
- DynamicBrcode resource
- rules attribute to Transfer resource
- Transfer.Rule sub-resource
- rules attribute to BrcodePayment resource
- BrcodePayment.Rule sub-resource
- Invoice.Discount error when an empty list was received
- missing "types" folder in the final package
- unset variables for Typescript compatibility
- setUser, getUser, setLanguage and getLanguage functions
- types for Organization and Project parameters
- type files to support TypeScript
- picture and pictureType parameters to Workspace.update method
- 'transactionIds' property to UtilityPayment resource
- 'transactionIds' property to BoletoPayment and TaxPayment resources
- 'fee', 'transactionIds', 'created' and 'updated' properties to DarfPayment resource
- datetime validation to 'created' and 'updated' fields
- starkbank-ecdsa library version to 1.1.4
- starkbank-ecdsa library version to 1.1.3
- Support for scheduled invoices, which will display discounts, fine, interest, etc. on the users banking interface when dates are used instead of datetimes
- PaymentPreview resource to preview multiple types of payments before confirmation: BrcodePreview, BoletoPreview, UtilityPreview and TaxPreview
- 'payment' account type for Pix related resources
- Transfer.description property to allow control over corresponding Transaction descriptions
- 'link' property to Invoice resource
- missing parameters to Boleto, DictKey, Invoice, Transaction, UtilityPayment and Workspace resources
- Invoice.Payment sub-resource to allow retrieval of invoice payment information
- pdf method for retrieving PDF receipts from reversed invoice logs
- Event.Attempt sub-resource to allow retrieval of information on failed webhook event delivery attempts
- page functions as a manual-pagination alternative to queries
- Institution resource to allow query of institutions recognized by the Brazilian Central Bank for Pix and TED transactions
- DarfPayment resource to allow DARF tax payment without bar code
- Event query by isDelivered
- Event async update
- workspace.update() to allow Workspace parameter updates
- PDF buffer fetch error treatment
- Bad '+' char URL encoding on BrcodePreview
- Event.workspaceId property to multiple Workspace Webhook identification
- Transfer.accountType property to allow 'checking', 'salary' or 'savings' account specification
- Transfer.externalId property to allow users to take control over duplication filters
- Organization user
- Workspace resource
- Invoice resource to load your account with dynamic QR Codes
- Deposit resource to receive transfers passively
- DictKey resource to get Pix key's parameters
- Pix support in Transfer resource
- BrcodePayment and BrcodePreview support to pay static and dynamic Pix QR Codes
- TaxPayment object and function calls to allow payment of DAS, DARF and ISS taxes
- BoletoHolmes to investigate boleto status according to CIP
- Fixed 'decamelize' dependency
- ids parameter to transaction.query
- ids parameter to transfer.query
- hiddenFields parameter to boleto.pdf
- ourNumber attribute to Boleto
- PaymentRequest resource to pass payments through manual approval flow
- transfer.scheduled parameter to allow Transfer scheduling
- starkbank.transfer.delete to cancel scheduled Transfers
- Transaction query by tags
- Change request library from Got to Axios for better compatibility
- Boleto PDF layout option
- Global error language option
- Transfer query taxId filter
- Test user credentials to environment variable instead of hard-code
- 'receiver_name' & 'receiver_tax_id' properties to Boleto entities
- Docstrings
- 'balance' property to Transaction entities
- 'discounts' property to Boleto entities
- Full Stark Bank API v2 compatibility