Skip to content

Make request optional when it has no required fields (fixes request={}) #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jfriedr wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −8
Open

Make request optional when it has no required fields (fixes request={}) #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion .speakeasy/gen.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ python:
inputTypedDictSuffix: TypedDict
license: MIT License
maxMethodParams: 3
methodArguments: require-security-and-request
methodArguments: infer-optional-args
methodTimeoutArgument: timeout-ms
methodTimeoutUnits: milliseconds
moduleName: ""
Expand Down
15 changes: 8 additions & 7 deletions MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,16 @@ These methods used to take individual arguments. They now take a single `request
| `tracking_status.create(carrier, tracking_number, metadata=None)` | `tracking_status.create(request={"carrier": ..., "tracking_number": ...})` |
| `rates_at_checkout.update_default_parcel_template(object_id=...)` | `rates_at_checkout.update_default_parcel_template(request={"object_id": ...})` |

**Known issue in 5.0.0b1:** the following methods take no parameters but still require an empty
`request=` argument. We plan to remove this requirement before 5.0.0 is final.
**Methods with no required parameters.** In 5.0.0b1 and 5.0.0b2, these methods required an empty
`request={}` argument. From 5.0.0b3 the argument is optional, so you can call them with no arguments
(passing `request={}` still works):

```python
shippo_sdk.service_groups.list(request={})
shippo_sdk.refunds.list(request={})
shippo_sdk.user_parcel_templates.list(request={})
shippo_sdk.rates_at_checkout.get_default_parcel_template(request={})
shippo_sdk.rates_at_checkout.delete_default_parcel_template(request={})
shippo_sdk.service_groups.list()
shippo_sdk.refunds.list()
shippo_sdk.user_parcel_templates.list()
shippo_sdk.rates_at_checkout.get_default_parcel_template()
shippo_sdk.rates_at_checkout.delete_default_parcel_template()
```

## 4. Models are pydantic, not dataclasses
Expand Down
Loading