openai-client-base 0.12.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

# \ProjectGroupsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_project_group**](ProjectGroupsApi.md#add_project_group) | **POST** /organization/projects/{project_id}/groups | Grants a group access to a project.
[**list_project_groups**](ProjectGroupsApi.md#list_project_groups) | **GET** /organization/projects/{project_id}/groups | Lists the groups that have access to a project.
[**remove_project_group**](ProjectGroupsApi.md#remove_project_group) | **DELETE** /organization/projects/{project_id}/groups/{group_id} | Revokes a group's access to a project.



## add_project_group

> models::ProjectGroup add_project_group(project_id, invite_project_group_body)
Grants a group access to a project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**invite_project_group_body** | [**InviteProjectGroupBody**](InviteProjectGroupBody.md) | Identifies the group and role to assign to the project. | [required] |

### Return type

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

### Authorization

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

### 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)


## list_project_groups

> models::ProjectGroupListResource list_project_groups(project_id, limit, after, order)
Lists the groups that have access to a project.

### 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 project groups to return. Defaults to 20. |  |[default to 20]
**after** | Option<**String**> | Cursor for pagination. Provide the ID of the last group from the previous response to fetch the next page. |  |
**order** | Option<**String**> | Sort order for the returned groups. |  |[default to asc]

### Return type

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

### Authorization

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

### 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)


## remove_project_group

> models::ProjectGroupDeletedResource remove_project_group(project_id, group_id)
Revokes a group's access to a project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**group_id** | **String** | The ID of the group to remove from the project. | [required] |

### Return type

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

### Authorization

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

### 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)