scaleway_api_rs 0.1.8

Generated library to interact with Scaleway API.
Documentation 
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

# \OptionsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_option**](OptionsApi.md#get_option) | **GET** /baremetal/v1/zones/{zone}/options/{option_id} | Get option
[**list_options**](OptionsApi.md#list_options) | **GET** /baremetal/v1/zones/{zone}/options | List options
[**list_settings**](OptionsApi.md#list_settings) | **GET** /baremetal/v1/zones/{zone}/settings | List all settings
[**update_setting**](OptionsApi.md#update_setting) | **PATCH** /baremetal/v1/zones/{zone}/settings/{setting_id} | Update setting



## get_option

> crate::models::ScalewayPeriodBaremetalPeriodV1PeriodOption get_option(zone, option_id)
Get option

Return specific option for the given ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**option_id** | **String** | ID of the option | [required] |

### Return type

[**crate::models::ScalewayPeriodBaremetalPeriodV1PeriodOption**](scaleway.baremetal.v1.Option.md)

### Authorization

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

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

> crate::models::ScalewayPeriodBaremetalPeriodV1PeriodListOptionsResponse list_options(zone, page, page_size, offer_id, name)
List options

List all options matching with filters.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**page** | Option<**i32**> | Page number |  |[default to 1]
**page_size** | Option<**i32**> | Number of options per page |  |[default to 20]
**offer_id** | Option<**String**> | Filter options by offer_id |  |
**name** | Option<**String**> | Filter options by name |  |

### Return type

[**crate::models::ScalewayPeriodBaremetalPeriodV1PeriodListOptionsResponse**](scaleway.baremetal.v1.ListOptionsResponse.md)

### Authorization

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

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

> crate::models::ScalewayPeriodBaremetalPeriodV1PeriodListSettingsResponse list_settings(zone, project_id, page, page_size, order_by)
List all settings

Return all settings for a project ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**project_id** | Option<**String**> | ID of the project (UUID format) | [required] |
**page** | Option<**i32**> | Page number |  |[default to 1]
**page_size** | Option<**i32**> | Set the maximum list size |  |[default to 20]
**order_by** | Option<**String**> | Order the response |  |[default to created_at_asc]

### Return type

[**crate::models::ScalewayPeriodBaremetalPeriodV1PeriodListSettingsResponse**](scaleway.baremetal.v1.ListSettingsResponse.md)

### Authorization

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

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

> crate::models::ScalewayPeriodBaremetalPeriodV1PeriodSetting update_setting(zone, setting_id, update_setting_request)
Update setting

Update a setting for a project ID (enable or disable).

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**zone** | **String** | The zone you want to target | [required] |
**setting_id** | **String** | ID of the setting | [required] |
**update_setting_request** | [**UpdateSettingRequest**](UpdateSettingRequest.md) |  | [required] |

### Return type

[**crate::models::ScalewayPeriodBaremetalPeriodV1PeriodSetting**](scaleway.baremetal.v1.Setting.md)

### Authorization

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

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