Skip to content

Commit 42e6db8

Browse files
committed
Release 0.0.320
1 parent 1972874 commit 42e6db8

50 files changed

Lines changed: 842 additions & 422 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.fern/metadata.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@
77
"enable_wire_tests": false,
88
"include_union_utils": true
99
},
10-
"originGitCommit": "7082e1f2f215e55d567b769dcf0f9732ab232c4d",
10+
"originGitCommit": "59a35aa03f5ab140800723e4add1a7933b8cf351",
1111
"originGitCommitIsDirty": true,
12-
"invokedBy": "ci",
13-
"requestedVersion": "0.0.319",
14-
"ciProvider": "github",
15-
"sdkVersion": "0.0.319"
12+
"invokedBy": "manual",
13+
"sdkVersion": "0.0.320"
1614
}

poetry.lock

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ dynamic = ["version"]
44

55
[tool.poetry]
66
name = "payabli"
7-
version = "0.0.319"
7+
version = "0.0.320"
88
description = ""
99
readme = "README.md"
1010
authors = []

reference.md

Lines changed: 40 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -193,30 +193,17 @@ client.bill.delete_attached_from_bill(
193193

194194
**filename:** `str`
195195

196-
The filename in Payabli. Filename is `zipName` in response to a
197-
request to `/api/Invoice/{idInvoice}`. Here, the filename is
198-
`0_Bill.pdf`.
199-
200-
```json
201-
"DocumentsRef": {
202-
"zipfile": "inva_269.zip",
203-
"filelist": [
204-
{
205-
"originalName": "Bill.pdf",
206-
"zipName": "0_Bill.pdf",
207-
"descriptor": null
208-
}
209-
]
210-
}
211-
```
196+
The filename in Payabli. Get this from the `zipName` field
197+
in the `DocumentsRef.filelist` array returned by
198+
`/api/Bill/{idBill}`. Example: `0_Bill.pdf`.
212199

213200
</dd>
214201
</dl>
215202

216203
<dl>
217204
<dd>
218205

219-
**return_object:** `typing.Optional[bool]` — When `true`, the request returns the file content as a Base64-encoded string.
206+
**return_object:** `typing.Optional[bool]` — When `true`, the response includes the full bill object.
220207

221208
</dd>
222209
</dl>
@@ -458,17 +445,9 @@ client.bill.get_attached_from_bill(
458445

459446
**filename:** `str`
460447

461-
The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
462-
"DocumentsRef": {
463-
"zipfile": "inva_269.zip",
464-
"filelist": [
465-
{
466-
"originalName": "Bill.pdf",
467-
"zipName": "0_Bill.pdf",
468-
"descriptor": null
469-
}
470-
]
471-
}
448+
The filename in Payabli. Get this from the `zipName` field
449+
in the `DocumentsRef.filelist` array returned by
450+
`/api/Bill/{idBill}`. Example: `0_Bill.pdf`.
472451

473452
</dd>
474453
</dl>
@@ -927,7 +906,8 @@ client = payabli(
927906
client.bill.modify_approval_bill(
928907
id_bill=285,
929908
request=[
930-
"string"
909+
"approver1@example.com",
910+
"approver2@example.com"
931911
],
932912
)
933913

@@ -2605,7 +2585,7 @@ client.charge_backs.get_chargeback(
26052585
<dl>
26062586
<dd>
26072587

2608-
**id:** `int` — ID of the chargeback or return record. This is returned as `chargebackId` in the [RecievedChargeback](/developers/developer-guides/webhook-payloads#receivedChargeback) and [ReceivedAchReturn](/developers/developer-guides/webhook-payloads#receivedachreturn) webhook notifications.
2588+
**id:** `int` — ID of the chargeback or return record. This is returned as `chargebackID` in the [ReceivedChargeBack](/guides/pay-ops-webhooks-payloads#receivedchargeback) and [ReceivedAchReturn](/guides/pay-ops-webhooks-payloads#receivedachreturn) webhook notifications.
26092589

26102590
</dd>
26112591
</dl>
@@ -9194,7 +9174,7 @@ client.hosted_payment_pages.load_page(
91949174
<dl>
91959175
<dd>
91969176

9197-
**subdomain:** `str` — Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
9177+
**subdomain:** `str` — Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
91989178

91999179
</dd>
92009180
</dl>
@@ -9368,7 +9348,7 @@ client.hosted_payment_pages.save_page(
93689348
<dl>
93699349
<dd>
93709350

9371-
**subdomain:** `str` — Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
9351+
**subdomain:** `str` — Payment page identifier. The subdomain value is the last part of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
93729352

93739353
</dd>
93749354
</dl>
@@ -9793,7 +9773,7 @@ client.invoice.add_invoice(
97939773
<dl>
97949774
<dd>
97959775

9796-
Deletes an invoice that's attached to a file.
9776+
Deletes a file attached to an invoice.
97979777
</dd>
97989778
</dl>
97999779
</dd>
@@ -9845,17 +9825,9 @@ client.invoice.delete_attached_from_invoice(
98459825

98469826
**filename:** `str`
98479827

9848-
The filename in Payabli. Filename is `zipName` in response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
9849-
"DocumentsRef": {
9850-
"zipfile": "inva_269.zip",
9851-
"filelist": [
9852-
{
9853-
"originalName": "Bill.pdf",
9854-
"zipName": "0_Bill.pdf",
9855-
"descriptor": null
9856-
}
9857-
]
9858-
}
9828+
The filename in Payabli. Get this from the `zipName` field
9829+
in the `DocumentsRef.filelist` array returned by
9830+
`/api/Invoice/{idInvoice}`. Example: `0_Bill.pdf`.
98599831

98609832
</dd>
98619833
</dl>
@@ -10115,19 +10087,9 @@ client.invoice.get_attached_file_from_invoice(
1011510087

1011610088
**filename:** `str`
1011710089

10118-
The filename in Payabli. Filename is `zipName` in the response to a request to `/api/Invoice/{idInvoice}`. Here, the filename is `0_Bill.pdf``.
10119-
```
10120-
"DocumentsRef": {
10121-
"zipfile": "inva_269.zip",
10122-
"filelist": [
10123-
{
10124-
"originalName": "Bill.pdf",
10125-
"zipName": "0_Bill.pdf",
10126-
"descriptor": null
10127-
}
10128-
]
10129-
}
10130-
```
10090+
The filename in Payabli. Get this from the `zipName` field
10091+
in the `DocumentsRef.filelist` array returned by
10092+
`/api/Invoice/{idInvoice}`. Example: `0_Bill.pdf`.
1013110093

1013210094
</dd>
1013310095
</dl>
@@ -14391,7 +14353,7 @@ client.money_out.reissue_out(
1439114353
<dl>
1439214354
<dd>
1439314355

14394-
Create a new notification or autogenerated report.
14356+
Create a new notification or auto-generated report.
1439514357
</dd>
1439614358
</dl>
1439714359
</dd>
@@ -14474,7 +14436,7 @@ client.notification.add_notification(
1447414436
<dl>
1447514437
<dd>
1447614438

14477-
Deletes a single notification or autogenerated report.
14439+
Deletes a single notification or auto-generated report.
1447814440
</dd>
1447914441
</dl>
1448014442
</dd>
@@ -14547,7 +14509,7 @@ client.notification.delete_notification(
1454714509
<dl>
1454814510
<dd>
1454914511

14550-
Retrieves a single notification or autogenerated report's details.
14512+
Retrieves a single notification or auto-generated report's details.
1455114513
</dd>
1455214514
</dl>
1455314515
</dd>
@@ -14620,7 +14582,7 @@ client.notification.get_notification(
1462014582
<dl>
1462114583
<dd>
1462214584

14623-
Update a notification or autogenerated report.
14585+
Update a notification or auto-generated report.
1462414586
</dd>
1462514587
</dl>
1462614588
</dd>
@@ -15934,7 +15896,7 @@ client.organization.get_basic_organization(
1593415896
<dl>
1593515897
<dd>
1593615898

15937-
Gets an organizations basic details by org ID.
15899+
Gets an organization's basic details by org ID.
1593815900
</dd>
1593915901
</dl>
1594015902
</dd>
@@ -18149,7 +18111,7 @@ client.payout_subscription.create_payout_subscription(
1814918111
)
1815018112
],
1815118113
schedule_details=PayoutScheduleDetail(
18152-
start_date="09/01/2025",
18114+
start_date="09/01/2027",
1815318115
end_date="09/01/2026",
1815418116
frequency="monthly",
1815518117
),
@@ -18665,7 +18627,7 @@ client.paypoint.get_entry_config(
1866518627
<dl>
1866618628
<dd>
1866718629

18668-
Gets the details for single payment page for a paypoint.
18630+
Gets the details for a single payment page for a paypoint.
1866918631
</dd>
1867018632
</dl>
1867118633
</dd>
@@ -18715,7 +18677,7 @@ client.paypoint.get_page(
1871518677
<dl>
1871618678
<dd>
1871718679

18718-
**subdomain:** `str` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
18680+
**subdomain:** `str` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
1871918681

1872018682
</dd>
1872118683
</dl>
@@ -18797,7 +18759,7 @@ client.paypoint.remove_page(
1879718759
<dl>
1879818760
<dd>
1879918761

18800-
**subdomain:** `str` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
18762+
**subdomain:** `str` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in `https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
1880118763

1880218764
</dd>
1880318765
</dl>
@@ -18910,7 +18872,7 @@ client.paypoint.save_logo(
1891018872
<dl>
1891118873
<dd>
1891218874

18913-
Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
18875+
Retrieves a paypoint's basic settings like custom fields, identifiers, and invoicing settings.
1891418876
</dd>
1891518877
</dl>
1891618878
</dd>
@@ -19250,7 +19212,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
1925019212
</dl>
1925119213
</details>
1925219214

19253-
<details><summary><code>client.query.<a href="src/payabli/query/client.py">list_batch_details_org</a>(...) -> QueryResponseSettlements</code></summary>
19215+
<details><summary><code>client.query.<a href="src/payabli/query/client.py">list_batch_details_org</a>(...) -> QueryBatchesDetailResponse</code></summary>
1925419216
<dl>
1925519217
<dd>
1925619218

@@ -26326,10 +26288,10 @@ client = payabli(
2632626288
client.statistic.basic_stats(
2632726289
entry_id=1000000,
2632826290
freq="m",
26329-
level=1,
26330-
mode="ytd",
26331-
end_date="2025-11-01",
26332-
start_date="2025-11-30",
26291+
level=2,
26292+
mode="custom",
26293+
start_date="2025-11-01",
26294+
end_date="2025-11-30",
2633326295
)
2633426296

2633526297
```
@@ -26617,7 +26579,7 @@ client = payabli(
2661726579
client.statistic.sub_stats(
2661826580
entry_id=1000000,
2661926581
interval="30",
26620-
level=1,
26582+
level=2,
2662126583
)
2662226584

2662326585
```
@@ -27222,7 +27184,7 @@ client.templates.delete_template(
2722227184
<dl>
2722327185
<dd>
2722427186

27225-
**template_id:** `float` — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
27187+
**template_id:** `float` — The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
2722627188

2722727189
</dd>
2722827190
</dl>
@@ -27296,15 +27258,15 @@ client.templates.getlink_template(
2729627258
<dl>
2729727259
<dd>
2729827260

27299-
**template_id:** `float` — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
27261+
**template_id:** `float` — The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
2730027262

2730127263
</dd>
2730227264
</dl>
2730327265

2730427266
<dl>
2730527267
<dd>
2730627268

27307-
**ignore_empty:** `bool` — Ignore read-only and empty fields Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
27269+
**ignore_empty:** `bool` — Ignore read-only and empty fields. Default is `false`. If `ignoreEmpty` = `false` and any field is empty, then the request returns a failure response. If `ignoreEmpty` = `true`, the request returns the boarding link name regardless of whether fields are empty.
2730827270

2730927271
</dd>
2731027272
</dl>
@@ -27377,7 +27339,7 @@ client.templates.get_template(
2737727339
<dl>
2737827340
<dd>
2737927341

27380-
**template_id:** `float` — The boarding template ID. Can be found at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
27342+
**template_id:** `float` — The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
2738127343

2738227344
</dd>
2738327345
</dl>
@@ -28232,7 +28194,7 @@ client.user.auth_user(
2823228194
<dl>
2823328195
<dd>
2823428196

28235-
**provider:** `str` — Auth provider. This fields is optional and defaults to null for the built-in provider.
28197+
**provider:** `str` — Auth provider. Pass `null` to use the built-in provider.
2823628198

2823728199
</dd>
2823828200
</dl>

0 commit comments

Comments
 (0)