openai-client-base 0.13.0

Auto-generated Rust client for the OpenAI API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252

# \SpendAlertsApi

All URIs are relative to *https://api.openai.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_organization_spend_alert**](SpendAlertsApi.md#create_organization_spend_alert) | **POST** /organization/spend_alerts | Creates an organization spend alert.
[**create_project_spend_alert**](SpendAlertsApi.md#create_project_spend_alert) | **POST** /organization/projects/{project_id}/spend_alerts | Creates a project spend alert.
[**delete_organization_spend_alert**](SpendAlertsApi.md#delete_organization_spend_alert) | **DELETE** /organization/spend_alerts/{alert_id} | Deletes an organization spend alert.
[**delete_project_spend_alert**](SpendAlertsApi.md#delete_project_spend_alert) | **DELETE** /organization/projects/{project_id}/spend_alerts/{alert_id} | Deletes a project spend alert.
[**list_organization_spend_alerts**](SpendAlertsApi.md#list_organization_spend_alerts) | **GET** /organization/spend_alerts | Lists organization spend alerts.
[**list_project_spend_alerts**](SpendAlertsApi.md#list_project_spend_alerts) | **GET** /organization/projects/{project_id}/spend_alerts | Lists project spend alerts.
[**update_organization_spend_alert**](SpendAlertsApi.md#update_organization_spend_alert) | **POST** /organization/spend_alerts/{alert_id} | Updates an organization spend alert.
[**update_project_spend_alert**](SpendAlertsApi.md#update_project_spend_alert) | **POST** /organization/projects/{project_id}/spend_alerts/{alert_id} | Updates a project spend alert.



## create_organization_spend_alert

> models::OrganizationSpendAlert create_organization_spend_alert(create_spend_alert_body)
Creates an organization spend alert.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_spend_alert_body** | [**CreateSpendAlertBody**](CreateSpendAlertBody.md) | Parameters for the organization spend alert you want to create. | [required] |

### Return type

[**models::OrganizationSpendAlert**](OrganizationSpendAlert.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_project_spend_alert

> models::ProjectSpendAlert create_project_spend_alert(project_id, create_spend_alert_body)
Creates a project spend alert.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**create_spend_alert_body** | [**CreateSpendAlertBody**](CreateSpendAlertBody.md) | Parameters for the project spend alert you want to create. | [required] |

### Return type

[**models::ProjectSpendAlert**](ProjectSpendAlert.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_organization_spend_alert

> models::OrganizationSpendAlertDeletedResource delete_organization_spend_alert(alert_id)
Deletes an organization spend alert.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alert_id** | **String** | The ID of the spend alert to delete. | [required] |

### Return type

[**models::OrganizationSpendAlertDeletedResource**](OrganizationSpendAlertDeletedResource.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_project_spend_alert

> models::ProjectSpendAlertDeletedResource delete_project_spend_alert(project_id, alert_id)
Deletes a project spend alert.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**alert_id** | **String** | The ID of the spend alert to delete. | [required] |

### Return type

[**models::ProjectSpendAlertDeletedResource**](ProjectSpendAlertDeletedResource.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_organization_spend_alerts

> models::OrganizationSpendAlertListResource list_organization_spend_alerts(limit, order, after, before)
Lists organization spend alerts.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**i32**> | A limit on the number of spend alerts to return. Defaults to 20. |  |
**order** | Option<**String**> | Sort order for the returned spend alerts. |  |[default to asc]
**after** | Option<**String**> | Cursor for pagination. Provide the ID of the last spend alert from the previous response to fetch the next page. |  |
**before** | Option<**String**> | Cursor for pagination. Provide the ID of the first spend alert from the previous response to fetch the previous page. |  |

### Return type

[**models::OrganizationSpendAlertListResource**](OrganizationSpendAlertListResource.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_project_spend_alerts

> models::ProjectSpendAlertListResource list_project_spend_alerts(project_id, limit, order, after, before)
Lists project spend alerts.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to inspect. | [required] |
**limit** | Option<**i32**> | A limit on the number of spend alerts to return. Defaults to 20. |  |
**order** | Option<**String**> | Sort order for the returned spend alerts. |  |[default to asc]
**after** | Option<**String**> | Cursor for pagination. Provide the ID of the last spend alert from the previous response to fetch the next page. |  |
**before** | Option<**String**> | Cursor for pagination. Provide the ID of the first spend alert from the previous response to fetch the previous page. |  |

### Return type

[**models::ProjectSpendAlertListResource**](ProjectSpendAlertListResource.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_organization_spend_alert

> models::OrganizationSpendAlert update_organization_spend_alert(alert_id, create_spend_alert_body)
Updates an organization spend alert.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**alert_id** | **String** | The ID of the spend alert to update. | [required] |
**create_spend_alert_body** | [**CreateSpendAlertBody**](CreateSpendAlertBody.md) | Fields to update on the organization spend alert. | [required] |

### Return type

[**models::OrganizationSpendAlert**](OrganizationSpendAlert.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_project_spend_alert

> models::ProjectSpendAlert update_project_spend_alert(project_id, alert_id, create_spend_alert_body)
Updates a project spend alert.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**alert_id** | **String** | The ID of the spend alert to update. | [required] |
**create_spend_alert_body** | [**CreateSpendAlertBody**](CreateSpendAlertBody.md) | Fields to update on the project spend alert. | [required] |

### Return type

[**models::ProjectSpendAlert**](ProjectSpendAlert.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)