@mittwald/api-client 4.465.0 → 4.467.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -0
- package/dist/esm/version.js +1 -1
- package/dist/types/generated/v2/client-react.d.ts +329 -327
- package/dist/types/generated/v2/client.d.ts +2658 -2633
- package/dist/types/generated/v2/types.d.ts +163 -32
- package/dist/types/generated/v3-next/client-react.d.ts +329 -327
- package/dist/types/generated/v3-next/client.d.ts +2658 -2633
- package/dist/types/generated/v3-next/types.d.ts +163 -32
- package/dist/types/version.d.ts +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -18,6 +18,7 @@ see the [LICENSE](../../LICENSE) file for details.
|
|
|
18
18
|
- [Setting request parameters](#setting-request-parameters)
|
|
19
19
|
- [Path parameters](#path-parameters)
|
|
20
20
|
- [Headers, query parameters and request body](#headers-query-parameters-and-request-body)
|
|
21
|
+
- [Date and time values](#date-and-time-values)
|
|
21
22
|
- [Example](#example)
|
|
22
23
|
- [Usage in React](#usage-in-react)
|
|
23
24
|
- [Installation](#installation)
|
|
@@ -151,6 +152,28 @@ const response = await mittwaldApi.category.operation({
|
|
|
151
152
|
});
|
|
152
153
|
```
|
|
153
154
|
|
|
155
|
+
#### Date and time values
|
|
156
|
+
|
|
157
|
+
Wherever the API expects a date and time (an ISO 8601 string in the API
|
|
158
|
+
documentation), you can either pass that string yourself or simply pass a
|
|
159
|
+
JavaScript `Date`. `Date` values are converted to ISO 8601 before the request is
|
|
160
|
+
sent – in the request body (at any nesting depth), in query parameters, path
|
|
161
|
+
parameters and headers.
|
|
162
|
+
|
|
163
|
+
```typescript
|
|
164
|
+
await mittwaldApi.contract.terminateContractItem({
|
|
165
|
+
contractId: "contract-id",
|
|
166
|
+
contractItemId: "contract-item-id",
|
|
167
|
+
data: {
|
|
168
|
+
terminationTargetDate: new Date("2024-12-10"),
|
|
169
|
+
},
|
|
170
|
+
});
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
Note that this applies to `date-time` values only. Date-only values
|
|
174
|
+
(`YYYY-MM-DD`) still have to be passed as a string, and responses always contain
|
|
175
|
+
strings, never `Date` objects.
|
|
176
|
+
|
|
154
177
|
## Example
|
|
155
178
|
|
|
156
179
|
```typescript
|
package/dist/esm/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const MittwaldAPIClientVersion = '4.
|
|
1
|
+
export const MittwaldAPIClientVersion = '4.466.0';
|