Skip to content

Commit 6177ef3

Browse files
committed
fix: rename customer.credits.ledger.create_entry_by_exteral_id and RequestValidationErrors (#9)
## Migration - RequestValidationErrors -> RequestValidationError - create_entry_by_exteral_id -> create_entry_by_external_id
1 parent e484056 commit 6177ef3

File tree

9 files changed

+113
-113
lines changed

9 files changed

+113
-113
lines changed

api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Types:
115115
from orb.types.customers.credits import (
116116
LedgerListResponse,
117117
LedgerCreateEntryResponse,
118-
LedgerCreateEntryByExteralIDResponse,
118+
LedgerCreateEntryByExternalIDResponse,
119119
LedgerListByExternalIDResponse,
120120
)
121121
```
@@ -124,7 +124,7 @@ Methods:
124124

125125
- <code title="get /customers/{customer_id}/credits/ledger">client.customers.credits.ledger.<a href="./src/orb/resources/customers/credits/ledger.py">list</a>(customer_id, \*\*<a href="src/orb/types/customers/credits/ledger_list_params.py">params</a>) -> <a href="./src/orb/types/customers/credits/ledger_list_response.py">SyncPage[LedgerListResponse]</a></code>
126126
- <code title="post /customers/{customer_id}/credits/ledger_entry">client.customers.credits.ledger.<a href="./src/orb/resources/customers/credits/ledger.py">create_entry</a>(customer_id, \*\*<a href="src/orb/types/customers/credits/ledger_create_entry_params.py">params</a>) -> <a href="./src/orb/types/customers/credits/ledger_create_entry_response.py">LedgerCreateEntryResponse</a></code>
127-
- <code title="post /customers/external_customer_id/{external_customer_id}/credits/ledger_entry">client.customers.credits.ledger.<a href="./src/orb/resources/customers/credits/ledger.py">create_entry_by_exteral_id</a>(external_customer_id, \*\*<a href="src/orb/types/customers/credits/ledger_create_entry_by_exteral_id_params.py">params</a>) -> <a href="./src/orb/types/customers/credits/ledger_create_entry_by_exteral_id_response.py">LedgerCreateEntryByExteralIDResponse</a></code>
127+
- <code title="post /customers/external_customer_id/{external_customer_id}/credits/ledger_entry">client.customers.credits.ledger.<a href="./src/orb/resources/customers/credits/ledger.py">create_entry_by_external_id</a>(external_customer_id, \*\*<a href="src/orb/types/customers/credits/ledger_create_entry_by_external_id_params.py">params</a>) -> <a href="./src/orb/types/customers/credits/ledger_create_entry_by_external_id_response.py">LedgerCreateEntryByExternalIDResponse</a></code>
128128
- <code title="get /customers/external_customer_id/{external_customer_id}/credits/ledger">client.customers.credits.ledger.<a href="./src/orb/resources/customers/credits/ledger.py">list_by_external_id</a>(external_customer_id, \*\*<a href="src/orb/types/customers/credits/ledger_list_by_external_id_params.py">params</a>) -> <a href="./src/orb/types/customers/credits/ledger_list_by_external_id_response.py">SyncPage[LedgerListByExternalIDResponse]</a></code>
129129

130130
## BalanceTransactions

src/orb/__init__.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
PermissionDeniedError,
3838
OrbAuthenticationError,
3939
OrbInternalServerError,
40-
RequestValidationErrors,
40+
RequestValidationError,
4141
UnprocessableEntityError,
4242
DuplicateResourceCreation,
4343
APIResponseValidationError,
@@ -66,7 +66,7 @@
6666
"RateLimitError",
6767
"InternalServerError",
6868
"DuplicateResourceCreation",
69-
"RequestValidationErrors",
69+
"RequestValidationError",
7070
"OrbAuthenticationError",
7171
"FeatureNotAvailable",
7272
"ResourceNotFound",

src/orb/_client.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ def _make_status_error(
203203
return _exceptions.FeatureNotAvailable(err_msg, response=response, body=body)
204204

205205
if type_ == "https://docs.withorb.com/reference/error-responses#400-request-validation-errors":
206-
return _exceptions.RequestValidationErrors(err_msg, response=response, body=body)
206+
return _exceptions.RequestValidationError(err_msg, response=response, body=body)
207207

208208
if type_ == "https://docs.withorb.com/reference/error-responses#401-authentication-error":
209209
return _exceptions.OrbAuthenticationError(err_msg, response=response, body=body)
@@ -434,7 +434,7 @@ def _make_status_error(
434434
return _exceptions.FeatureNotAvailable(err_msg, response=response, body=body)
435435

436436
if type_ == "https://docs.withorb.com/reference/error-responses#400-request-validation-errors":
437-
return _exceptions.RequestValidationErrors(err_msg, response=response, body=body)
437+
return _exceptions.RequestValidationError(err_msg, response=response, body=body)
438438

439439
if type_ == "https://docs.withorb.com/reference/error-responses#401-authentication-error":
440440
return _exceptions.OrbAuthenticationError(err_msg, response=response, body=body)

src/orb/_exceptions.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"InternalServerError",
2121
"DuplicateResourceCreation",
2222
"FeatureNotAvailable",
23-
"RequestValidationErrors",
23+
"RequestValidationError",
2424
"OrbAuthenticationError",
2525
"ResourceNotFound",
2626
"URLNotFound",
@@ -161,7 +161,7 @@ def __init__(self, message: str, *, body: object, response: httpx.Response) -> N
161161
self.detail = cast(Any, data.get("detail"))
162162

163163

164-
class RequestValidationErrors(BadRequestError):
164+
class RequestValidationError(BadRequestError):
165165
status: Literal[400]
166166

167167
type: Literal["https://docs.withorb.com/reference/error-responses#400-request-validation-errors"]

src/orb/resources/customers/credits/ledger.py

+36-36
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
LedgerListResponse,
1616
LedgerCreateEntryResponse,
1717
LedgerListByExternalIDResponse,
18-
LedgerCreateEntryByExteralIDResponse,
18+
LedgerCreateEntryByExternalIDResponse,
1919
ledger_list_params,
2020
ledger_create_entry_params,
2121
ledger_list_by_external_id_params,
22-
ledger_create_entry_by_exteral_id_params,
22+
ledger_create_entry_by_external_id_params,
2323
)
2424

2525
__all__ = ["Ledger", "AsyncLedger"]
@@ -1042,7 +1042,7 @@ def create_entry(
10421042
)
10431043

10441044
@overload
1045-
def create_entry_by_exteral_id(
1045+
def create_entry_by_external_id(
10461046
self,
10471047
external_customer_id: Optional[str],
10481048
*,
@@ -1052,7 +1052,7 @@ def create_entry_by_exteral_id(
10521052
effective_date: Union[str, date, None] | NotGiven = NOT_GIVEN,
10531053
expiry_date: Union[str, date, None] | NotGiven = NOT_GIVEN,
10541054
invoice_settings: Optional[
1055-
ledger_create_entry_by_exteral_id_params.AddIncrementCreditLedgerEntryRequestParamsInvoiceSettings
1055+
ledger_create_entry_by_external_id_params.AddIncrementCreditLedgerEntryRequestParamsInvoiceSettings
10561056
]
10571057
| NotGiven = NOT_GIVEN,
10581058
metadata: object | NotGiven = NOT_GIVEN,
@@ -1064,7 +1064,7 @@ def create_entry_by_exteral_id(
10641064
extra_body: Body | None = None,
10651065
timeout: float | None | NotGiven = NOT_GIVEN,
10661066
idempotency_key: str | None = None,
1067-
) -> LedgerCreateEntryByExteralIDResponse:
1067+
) -> LedgerCreateEntryByExternalIDResponse:
10681068
"""
10691069
This endpoint allows you to create a new ledger entry for a specified customer's
10701070
balance. This can be used to increment balance, deduct credits, and change the
@@ -1213,7 +1213,7 @@ def create_entry_by_exteral_id(
12131213
...
12141214

12151215
@overload
1216-
def create_entry_by_exteral_id(
1216+
def create_entry_by_external_id(
12171217
self,
12181218
external_customer_id: Optional[str],
12191219
*,
@@ -1228,7 +1228,7 @@ def create_entry_by_exteral_id(
12281228
extra_body: Body | None = None,
12291229
timeout: float | None | NotGiven = NOT_GIVEN,
12301230
idempotency_key: str | None = None,
1231-
) -> LedgerCreateEntryByExteralIDResponse:
1231+
) -> LedgerCreateEntryByExternalIDResponse:
12321232
"""
12331233
This endpoint allows you to create a new ledger entry for a specified customer's
12341234
balance. This can be used to increment balance, deduct credits, and change the
@@ -1363,7 +1363,7 @@ def create_entry_by_exteral_id(
13631363
...
13641364

13651365
@overload
1366-
def create_entry_by_exteral_id(
1366+
def create_entry_by_external_id(
13671367
self,
13681368
external_customer_id: Optional[str],
13691369
*,
@@ -1381,7 +1381,7 @@ def create_entry_by_exteral_id(
13811381
extra_body: Body | None = None,
13821382
timeout: float | None | NotGiven = NOT_GIVEN,
13831383
idempotency_key: str | None = None,
1384-
) -> LedgerCreateEntryByExteralIDResponse:
1384+
) -> LedgerCreateEntryByExternalIDResponse:
13851385
"""
13861386
This endpoint allows you to create a new ledger entry for a specified customer's
13871387
balance. This can be used to increment balance, deduct credits, and change the
@@ -1526,7 +1526,7 @@ def create_entry_by_exteral_id(
15261526
...
15271527

15281528
@overload
1529-
def create_entry_by_exteral_id(
1529+
def create_entry_by_external_id(
15301530
self,
15311531
external_customer_id: Optional[str],
15321532
*,
@@ -1543,7 +1543,7 @@ def create_entry_by_exteral_id(
15431543
extra_body: Body | None = None,
15441544
timeout: float | None | NotGiven = NOT_GIVEN,
15451545
idempotency_key: str | None = None,
1546-
) -> LedgerCreateEntryByExteralIDResponse:
1546+
) -> LedgerCreateEntryByExternalIDResponse:
15471547
"""
15481548
This endpoint allows you to create a new ledger entry for a specified customer's
15491549
balance. This can be used to increment balance, deduct credits, and change the
@@ -1682,7 +1682,7 @@ def create_entry_by_exteral_id(
16821682
...
16831683

16841684
@overload
1685-
def create_entry_by_exteral_id(
1685+
def create_entry_by_external_id(
16861686
self,
16871687
external_customer_id: Optional[str],
16881688
*,
@@ -1698,7 +1698,7 @@ def create_entry_by_exteral_id(
16981698
extra_body: Body | None = None,
16991699
timeout: float | None | NotGiven = NOT_GIVEN,
17001700
idempotency_key: str | None = None,
1701-
) -> LedgerCreateEntryByExteralIDResponse:
1701+
) -> LedgerCreateEntryByExternalIDResponse:
17021702
"""
17031703
This endpoint allows you to create a new ledger entry for a specified customer's
17041704
balance. This can be used to increment balance, deduct credits, and change the
@@ -1841,7 +1841,7 @@ def create_entry_by_exteral_id(
18411841
["amount", "block_id", "entry_type"],
18421842
["amount", "block_id", "entry_type"],
18431843
)
1844-
def create_entry_by_exteral_id(
1844+
def create_entry_by_external_id(
18451845
self,
18461846
external_customer_id: Optional[str],
18471847
*,
@@ -1855,7 +1855,7 @@ def create_entry_by_exteral_id(
18551855
effective_date: Union[str, date, None] | NotGiven = NOT_GIVEN,
18561856
expiry_date: Union[str, date, None] | NotGiven = NOT_GIVEN,
18571857
invoice_settings: Optional[
1858-
ledger_create_entry_by_exteral_id_params.AddIncrementCreditLedgerEntryRequestParamsInvoiceSettings
1858+
ledger_create_entry_by_external_id_params.AddIncrementCreditLedgerEntryRequestParamsInvoiceSettings
18591859
]
18601860
| NotGiven = NOT_GIVEN,
18611861
metadata: object | NotGiven = NOT_GIVEN,
@@ -1870,9 +1870,9 @@ def create_entry_by_exteral_id(
18701870
extra_body: Body | None = None,
18711871
timeout: float | None | NotGiven = NOT_GIVEN,
18721872
idempotency_key: str | None = None,
1873-
) -> LedgerCreateEntryByExteralIDResponse:
1873+
) -> LedgerCreateEntryByExternalIDResponse:
18741874
return cast(
1875-
LedgerCreateEntryByExteralIDResponse,
1875+
LedgerCreateEntryByExternalIDResponse,
18761876
self._post(
18771877
f"/customers/external_customer_id/{external_customer_id}/credits/ledger_entry",
18781878
body=maybe_transform(
@@ -1889,7 +1889,7 @@ def create_entry_by_exteral_id(
18891889
"block_id": block_id,
18901890
"void_reason": void_reason,
18911891
},
1892-
ledger_create_entry_by_exteral_id_params.LedgerCreateEntryByExteralIDParams,
1892+
ledger_create_entry_by_external_id_params.LedgerCreateEntryByExternalIDParams,
18931893
),
18941894
options=make_request_options(
18951895
extra_headers=extra_headers,
@@ -1899,7 +1899,7 @@ def create_entry_by_exteral_id(
18991899
idempotency_key=idempotency_key,
19001900
),
19011901
cast_to=cast(
1902-
Any, LedgerCreateEntryByExteralIDResponse
1902+
Any, LedgerCreateEntryByExternalIDResponse
19031903
), # Union types cannot be passed in as arguments in the type system
19041904
),
19051905
)
@@ -3080,7 +3080,7 @@ async def create_entry(
30803080
)
30813081

30823082
@overload
3083-
async def create_entry_by_exteral_id(
3083+
async def create_entry_by_external_id(
30843084
self,
30853085
external_customer_id: Optional[str],
30863086
*,
@@ -3090,7 +3090,7 @@ async def create_entry_by_exteral_id(
30903090
effective_date: Union[str, date, None] | NotGiven = NOT_GIVEN,
30913091
expiry_date: Union[str, date, None] | NotGiven = NOT_GIVEN,
30923092
invoice_settings: Optional[
3093-
ledger_create_entry_by_exteral_id_params.AddIncrementCreditLedgerEntryRequestParamsInvoiceSettings
3093+
ledger_create_entry_by_external_id_params.AddIncrementCreditLedgerEntryRequestParamsInvoiceSettings
30943094
]
30953095
| NotGiven = NOT_GIVEN,
30963096
metadata: object | NotGiven = NOT_GIVEN,
@@ -3102,7 +3102,7 @@ async def create_entry_by_exteral_id(
31023102
extra_body: Body | None = None,
31033103
timeout: float | None | NotGiven = NOT_GIVEN,
31043104
idempotency_key: str | None = None,
3105-
) -> LedgerCreateEntryByExteralIDResponse:
3105+
) -> LedgerCreateEntryByExternalIDResponse:
31063106
"""
31073107
This endpoint allows you to create a new ledger entry for a specified customer's
31083108
balance. This can be used to increment balance, deduct credits, and change the
@@ -3251,7 +3251,7 @@ async def create_entry_by_exteral_id(
32513251
...
32523252

32533253
@overload
3254-
async def create_entry_by_exteral_id(
3254+
async def create_entry_by_external_id(
32553255
self,
32563256
external_customer_id: Optional[str],
32573257
*,
@@ -3266,7 +3266,7 @@ async def create_entry_by_exteral_id(
32663266
extra_body: Body | None = None,
32673267
timeout: float | None | NotGiven = NOT_GIVEN,
32683268
idempotency_key: str | None = None,
3269-
) -> LedgerCreateEntryByExteralIDResponse:
3269+
) -> LedgerCreateEntryByExternalIDResponse:
32703270
"""
32713271
This endpoint allows you to create a new ledger entry for a specified customer's
32723272
balance. This can be used to increment balance, deduct credits, and change the
@@ -3401,7 +3401,7 @@ async def create_entry_by_exteral_id(
34013401
...
34023402

34033403
@overload
3404-
async def create_entry_by_exteral_id(
3404+
async def create_entry_by_external_id(
34053405
self,
34063406
external_customer_id: Optional[str],
34073407
*,
@@ -3419,7 +3419,7 @@ async def create_entry_by_exteral_id(
34193419
extra_body: Body | None = None,
34203420
timeout: float | None | NotGiven = NOT_GIVEN,
34213421
idempotency_key: str | None = None,
3422-
) -> LedgerCreateEntryByExteralIDResponse:
3422+
) -> LedgerCreateEntryByExternalIDResponse:
34233423
"""
34243424
This endpoint allows you to create a new ledger entry for a specified customer's
34253425
balance. This can be used to increment balance, deduct credits, and change the
@@ -3564,7 +3564,7 @@ async def create_entry_by_exteral_id(
35643564
...
35653565

35663566
@overload
3567-
async def create_entry_by_exteral_id(
3567+
async def create_entry_by_external_id(
35683568
self,
35693569
external_customer_id: Optional[str],
35703570
*,
@@ -3581,7 +3581,7 @@ async def create_entry_by_exteral_id(
35813581
extra_body: Body | None = None,
35823582
timeout: float | None | NotGiven = NOT_GIVEN,
35833583
idempotency_key: str | None = None,
3584-
) -> LedgerCreateEntryByExteralIDResponse:
3584+
) -> LedgerCreateEntryByExternalIDResponse:
35853585
"""
35863586
This endpoint allows you to create a new ledger entry for a specified customer's
35873587
balance. This can be used to increment balance, deduct credits, and change the
@@ -3720,7 +3720,7 @@ async def create_entry_by_exteral_id(
37203720
...
37213721

37223722
@overload
3723-
async def create_entry_by_exteral_id(
3723+
async def create_entry_by_external_id(
37243724
self,
37253725
external_customer_id: Optional[str],
37263726
*,
@@ -3736,7 +3736,7 @@ async def create_entry_by_exteral_id(
37363736
extra_body: Body | None = None,
37373737
timeout: float | None | NotGiven = NOT_GIVEN,
37383738
idempotency_key: str | None = None,
3739-
) -> LedgerCreateEntryByExteralIDResponse:
3739+
) -> LedgerCreateEntryByExternalIDResponse:
37403740
"""
37413741
This endpoint allows you to create a new ledger entry for a specified customer's
37423742
balance. This can be used to increment balance, deduct credits, and change the
@@ -3879,7 +3879,7 @@ async def create_entry_by_exteral_id(
38793879
["amount", "block_id", "entry_type"],
38803880
["amount", "block_id", "entry_type"],
38813881
)
3882-
async def create_entry_by_exteral_id(
3882+
async def create_entry_by_external_id(
38833883
self,
38843884
external_customer_id: Optional[str],
38853885
*,
@@ -3893,7 +3893,7 @@ async def create_entry_by_exteral_id(
38933893
effective_date: Union[str, date, None] | NotGiven = NOT_GIVEN,
38943894
expiry_date: Union[str, date, None] | NotGiven = NOT_GIVEN,
38953895
invoice_settings: Optional[
3896-
ledger_create_entry_by_exteral_id_params.AddIncrementCreditLedgerEntryRequestParamsInvoiceSettings
3896+
ledger_create_entry_by_external_id_params.AddIncrementCreditLedgerEntryRequestParamsInvoiceSettings
38973897
]
38983898
| NotGiven = NOT_GIVEN,
38993899
metadata: object | NotGiven = NOT_GIVEN,
@@ -3908,9 +3908,9 @@ async def create_entry_by_exteral_id(
39083908
extra_body: Body | None = None,
39093909
timeout: float | None | NotGiven = NOT_GIVEN,
39103910
idempotency_key: str | None = None,
3911-
) -> LedgerCreateEntryByExteralIDResponse:
3911+
) -> LedgerCreateEntryByExternalIDResponse:
39123912
return cast(
3913-
LedgerCreateEntryByExteralIDResponse,
3913+
LedgerCreateEntryByExternalIDResponse,
39143914
await self._post(
39153915
f"/customers/external_customer_id/{external_customer_id}/credits/ledger_entry",
39163916
body=maybe_transform(
@@ -3927,7 +3927,7 @@ async def create_entry_by_exteral_id(
39273927
"block_id": block_id,
39283928
"void_reason": void_reason,
39293929
},
3930-
ledger_create_entry_by_exteral_id_params.LedgerCreateEntryByExteralIDParams,
3930+
ledger_create_entry_by_external_id_params.LedgerCreateEntryByExternalIDParams,
39313931
),
39323932
options=make_request_options(
39333933
extra_headers=extra_headers,
@@ -3937,7 +3937,7 @@ async def create_entry_by_exteral_id(
39373937
idempotency_key=idempotency_key,
39383938
),
39393939
cast_to=cast(
3940-
Any, LedgerCreateEntryByExteralIDResponse
3940+
Any, LedgerCreateEntryByExternalIDResponse
39413941
), # Union types cannot be passed in as arguments in the type system
39423942
),
39433943
)

src/orb/types/customers/credits/__init__.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
from .ledger_list_by_external_id_response import (
1717
LedgerListByExternalIDResponse as LedgerListByExternalIDResponse,
1818
)
19-
from .ledger_create_entry_by_exteral_id_params import (
20-
LedgerCreateEntryByExteralIDParams as LedgerCreateEntryByExteralIDParams,
19+
from .ledger_create_entry_by_external_id_params import (
20+
LedgerCreateEntryByExternalIDParams as LedgerCreateEntryByExternalIDParams,
2121
)
22-
from .ledger_create_entry_by_exteral_id_response import (
23-
LedgerCreateEntryByExteralIDResponse as LedgerCreateEntryByExteralIDResponse,
22+
from .ledger_create_entry_by_external_id_response import (
23+
LedgerCreateEntryByExternalIDResponse as LedgerCreateEntryByExternalIDResponse,
2424
)

0 commit comments

Comments
 (0)