Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Given a version number MAJOR.MINOR.PATCH, increment:


## [Unreleased]
### Added
- Added `starkinfra.creditnote.document_pdf` function to retrieve CCB document PDF.

## [0.20.0] - 2025-05-13
### Added
Expand Down
13 changes: 13 additions & 0 deletions starkinfra/creditnote/__creditnote.py
Original file line number Diff line number Diff line change
Expand Up @@ -243,3 +243,16 @@ def pdf(noteId, user=None):
- Transfer pdf file
"""
return rest.get_content(resource=_resource, id=noteId, user=user, sub_resource_name="payment/pdf")


def document_pdf(noteId, user=None):
"""# Retrieve CCB document
Receive a CCB document pdf file.
## Parameters (required):
- noteId [string]: object unique id. ex: "5656565656565656"
## Parameters (optional):
- user [Organization/Project object, default None]: Organization or Project object. Not necessary if starkinfra.user was set before function call.
## Return:
- CCB document pdf file
"""
return rest.get_content(resource=_resource, id=noteId, user=user, sub_resource_name="pdf")
2 changes: 1 addition & 1 deletion starkinfra/creditnote/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
from .invoice.__invoice import Invoice
from .invoice.__discount import Discount
from .invoice.__description import Description
from .__creditnote import create, get, query, page, cancel, pdf
from .__creditnote import create, get, query, page, cancel, pdf, document_pdf
7 changes: 7 additions & 0 deletions tests/sdk/testCreditNote.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ def test_success(self):
self.assertGreater(len(pdf), 1000)


class TestCreditNoteSignPdf(TestCase):

def test_success(self):
pdf = starkinfra.creditnote.document_pdf(os.environ["SANDBOX_SIGNED_CREDIT_NOTE_ID"])
self.assertGreater(len(pdf), 1000)


class TestCreditNoteQuery(TestCase):

def test_success_after_before(self):
Expand Down