about summary refs log tree commit diff stats
path: root/crates/rocie-client/docs/ApiSetAuthBarcodeApi.md
blob: 357c26bfc36e1a5003d38480fbd46efa936053c7 (plain) (blame)
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
# \\ApiSetAuthBarcodeApi

All URIs are relative to _http://localhost_

| Method                                                         | HTTP request                               | Description        |
| -------------------------------------------------------------- | ------------------------------------------ | ------------------ |
| [**buy_barcode**](ApiSetAuthBarcodeApi.md#buy_barcode)         | **POST** /barcode/{barcode_id}/buy/{times} | Buy an barcode     |
| [**consume_barcode**](ApiSetAuthBarcodeApi.md#consume_barcode) | **POST** /barcode/{id}/consume             | Consume an barcode |

## buy_barcode

> buy_barcode(barcode_id, times) Buy an barcode

### Parameters

| Name           | Type                 | Description                      | Required   | Notes |
| -------------- | -------------------- | -------------------------------- | ---------- | ----- |
| **barcode_id** | [**BarcodeId**](.md) | The numeric value of the barcode | [required] |
| **times**      | **u32**              | How often to buy the barcode     | [required] |

### Return type

(empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

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

## consume_barcode

> consume_barcode(id, unit_amount) Consume an barcode

### Parameters

| Name            | Type                            | Description                      | Required   | Notes |
| --------------- | ------------------------------- | -------------------------------- | ---------- | ----- |
| **id**          | [**BarcodeId**](.md)            | The numeric value of the barcode | [required] |
| **unit_amount** | [**UnitAmount**](UnitAmount.md) |                                  | [required] |

### Return type

(empty response body)

### Authorization

No authorization required

### HTTP request headers

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

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