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 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
|
// This file was automatically generated. DO NOT EDIT.
// If you have any remark or suggestion do not hesitate to open an issue.
// Package test provides methods and message types of the test v1 API.
package test
import (
"bytes"
"encoding/json"
"fmt"
"net"
"net/http"
"net/url"
"strings"
"time"
"github.com/scaleway/scaleway-sdk-go/internal/errors"
"github.com/scaleway/scaleway-sdk-go/internal/marshaler"
"github.com/scaleway/scaleway-sdk-go/internal/parameter"
"github.com/scaleway/scaleway-sdk-go/namegenerator"
"github.com/scaleway/scaleway-sdk-go/scw"
)
// always import dependencies
var (
_ fmt.Stringer
_ json.Unmarshaler
_ url.URL
_ net.IP
_ http.Header
_ bytes.Reader
_ time.Time
_ = strings.Join
_ scw.ScalewayRequest
_ marshaler.Duration
_ scw.File
_ = parameter.AddToQuery
_ = namegenerator.GetRandomName
)
// API: no Auth Service for end-to-end testing
//
// Test is a fake service that aim to manage fake humans. It is used for internal and public end-to-end tests.
//
// This service don't use the Scaleway authentication service but a fake one.
// It allows to use this test service publicly without requiring a Scaleway account.
//
// First, you need to register a user with `scw test human register` to get an access-key.
// Then, you can use other test commands by setting the SCW_SECRET_KEY env variable.
//
type API struct {
client *scw.Client
}
// NewAPI returns a API object from a Scaleway client.
func NewAPI(client *scw.Client) *API {
return &API{
client: client,
}
}
type EyeColors string
const (
// EyeColorsUnknown is [insert doc].
EyeColorsUnknown = EyeColors("unknown")
// EyeColorsAmber is [insert doc].
EyeColorsAmber = EyeColors("amber")
// EyeColorsBlue is [insert doc].
EyeColorsBlue = EyeColors("blue")
// EyeColorsBrown is [insert doc].
EyeColorsBrown = EyeColors("brown")
// EyeColorsGray is [insert doc].
EyeColorsGray = EyeColors("gray")
// EyeColorsGreen is [insert doc].
EyeColorsGreen = EyeColors("green")
// EyeColorsHazel is [insert doc].
EyeColorsHazel = EyeColors("hazel")
// EyeColorsRed is [insert doc].
EyeColorsRed = EyeColors("red")
// EyeColorsViolet is [insert doc].
EyeColorsViolet = EyeColors("violet")
)
func (enum EyeColors) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum EyeColors) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *EyeColors) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = EyeColors(EyeColors(tmp).String())
return nil
}
type HumanStatus string
const (
// HumanStatusUnknown is [insert doc].
HumanStatusUnknown = HumanStatus("unknown")
// HumanStatusStopped is [insert doc].
HumanStatusStopped = HumanStatus("stopped")
// HumanStatusRunning is [insert doc].
HumanStatusRunning = HumanStatus("running")
)
func (enum HumanStatus) String() string {
if enum == "" {
// return default value if empty
return "unknown"
}
return string(enum)
}
func (enum HumanStatus) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *HumanStatus) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = HumanStatus(HumanStatus(tmp).String())
return nil
}
type ListHumansRequestOrderBy string
const (
// ListHumansRequestOrderByCreatedAtAsc is [insert doc].
ListHumansRequestOrderByCreatedAtAsc = ListHumansRequestOrderBy("created_at_asc")
// ListHumansRequestOrderByCreatedAtDesc is [insert doc].
ListHumansRequestOrderByCreatedAtDesc = ListHumansRequestOrderBy("created_at_desc")
// ListHumansRequestOrderByUpdatedAtAsc is [insert doc].
ListHumansRequestOrderByUpdatedAtAsc = ListHumansRequestOrderBy("updated_at_asc")
// ListHumansRequestOrderByUpdatedAtDesc is [insert doc].
ListHumansRequestOrderByUpdatedAtDesc = ListHumansRequestOrderBy("updated_at_desc")
// ListHumansRequestOrderByHeightAsc is [insert doc].
ListHumansRequestOrderByHeightAsc = ListHumansRequestOrderBy("height_asc")
// ListHumansRequestOrderByHeightDesc is [insert doc].
ListHumansRequestOrderByHeightDesc = ListHumansRequestOrderBy("height_desc")
)
func (enum ListHumansRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListHumansRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListHumansRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListHumansRequestOrderBy(ListHumansRequestOrderBy(tmp).String())
return nil
}
type Human struct {
ID string `json:"id"`
OrganizationID string `json:"organization_id"`
CreatedAt *time.Time `json:"created_at"`
UpdatedAt *time.Time `json:"updated_at"`
Height float64 `json:"height"`
ShoeSize float32 `json:"shoe_size"`
AltitudeInMeter int32 `json:"altitude_in_meter"`
AltitudeInMillimeter int64 `json:"altitude_in_millimeter"`
FingersCount uint32 `json:"fingers_count"`
HairCount uint64 `json:"hair_count"`
IsHappy bool `json:"is_happy"`
// EyesColor:
//
// Default value: unknown
EyesColor EyeColors `json:"eyes_color"`
// Status:
//
// Default value: unknown
Status HumanStatus `json:"status"`
Name string `json:"name"`
ProjectID string `json:"project_id"`
}
type ListHumansResponse struct {
TotalCount uint32 `json:"total_count"`
Humans []*Human `json:"humans"`
}
type RegisterResponse struct {
SecretKey string `json:"secret_key"`
AccessKey string `json:"access_key"`
}
// Service API
type RegisterRequest struct {
Username string `json:"username"`
}
// Register: register a user
//
// Register a human and return a access-key and a secret-key that must be used in all other commands.
//
// Hint: you can use other test commands by setting the SCW_SECRET_KEY env variable.
//
func (s *API) Register(req *RegisterRequest, opts ...scw.RequestOption) (*RegisterResponse, error) {
var err error
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/test/v1/register",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp RegisterResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListHumansRequest struct {
Page *int32 `json:"-"`
PageSize *uint32 `json:"-"`
// OrderBy:
//
// Default value: created_at_asc
OrderBy ListHumansRequestOrderBy `json:"-"`
OrganizationID *string `json:"-"`
ProjectID *string `json:"-"`
}
// ListHumans: list all your humans
func (s *API) ListHumans(req *ListHumansRequest, opts ...scw.RequestOption) (*ListHumansResponse, error) {
var err error
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "order_by", req.OrderBy)
parameter.AddToQuery(query, "organization_id", req.OrganizationID)
parameter.AddToQuery(query, "project_id", req.ProjectID)
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/test/v1/humans",
Query: query,
Headers: http.Header{},
}
var resp ListHumansResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetHumanRequest struct {
// HumanID: UUID of the human you want to get
HumanID string `json:"-"`
}
// GetHuman: get human details
//
// Get the human details associated with the given id.
func (s *API) GetHuman(req *GetHumanRequest, opts ...scw.RequestOption) (*Human, error) {
var err error
if fmt.Sprint(req.HumanID) == "" {
return nil, errors.New("field HumanID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/test/v1/humans/" + fmt.Sprint(req.HumanID) + "",
Headers: http.Header{},
}
var resp Human
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type CreateHumanRequest struct {
Height float64 `json:"height"`
ShoeSize float32 `json:"shoe_size"`
AltitudeInMeter int32 `json:"altitude_in_meter"`
AltitudeInMillimeter int64 `json:"altitude_in_millimeter"`
FingersCount uint32 `json:"fingers_count"`
HairCount uint64 `json:"hair_count"`
IsHappy bool `json:"is_happy"`
// EyesColor:
//
// Default value: unknown
EyesColor EyeColors `json:"eyes_color"`
// Deprecated
// Precisely one of OrganizationID, ProjectID must be set.
OrganizationID *string `json:"organization_id,omitempty"`
Name string `json:"name"`
// Precisely one of OrganizationID, ProjectID must be set.
ProjectID *string `json:"project_id,omitempty"`
}
// CreateHuman: create a new human
func (s *API) CreateHuman(req *CreateHumanRequest, opts ...scw.RequestOption) (*Human, error) {
var err error
defaultProjectID, exist := s.client.GetDefaultProjectID()
if exist && req.OrganizationID == nil && req.ProjectID == nil {
req.ProjectID = &defaultProjectID
}
defaultOrganizationID, exist := s.client.GetDefaultOrganizationID()
if exist && req.OrganizationID == nil && req.ProjectID == nil {
req.OrganizationID = &defaultOrganizationID
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/test/v1/humans",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Human
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type UpdateHumanRequest struct {
// HumanID: UUID of the human you want to update
HumanID string `json:"-"`
Height *float64 `json:"height"`
ShoeSize *float32 `json:"shoe_size"`
AltitudeInMeter *int32 `json:"altitude_in_meter"`
AltitudeInMillimeter *int64 `json:"altitude_in_millimeter"`
FingersCount *uint32 `json:"fingers_count"`
HairCount *uint64 `json:"hair_count"`
IsHappy *bool `json:"is_happy"`
// EyesColor:
//
// Default value: unknown
EyesColor EyeColors `json:"eyes_color"`
Name *string `json:"name"`
}
// UpdateHuman: update an existing human
//
// Update the human associated with the given id.
func (s *API) UpdateHuman(req *UpdateHumanRequest, opts ...scw.RequestOption) (*Human, error) {
var err error
if fmt.Sprint(req.HumanID) == "" {
return nil, errors.New("field HumanID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "PATCH",
Path: "/test/v1/humans/" + fmt.Sprint(req.HumanID) + "",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Human
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type DeleteHumanRequest struct {
// HumanID: UUID of the human you want to delete
HumanID string `json:"-"`
}
// DeleteHuman: delete an existing human
//
// Delete the human associated with the given id.
func (s *API) DeleteHuman(req *DeleteHumanRequest, opts ...scw.RequestOption) (*Human, error) {
var err error
if fmt.Sprint(req.HumanID) == "" {
return nil, errors.New("field HumanID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/test/v1/humans/" + fmt.Sprint(req.HumanID) + "",
Headers: http.Header{},
}
var resp Human
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type RunHumanRequest struct {
// HumanID: UUID of the human you want to make run
HumanID string `json:"-"`
}
// RunHuman: start a 1h running for the given human
//
// Start a one hour running for the given human.
func (s *API) RunHuman(req *RunHumanRequest, opts ...scw.RequestOption) (*Human, error) {
var err error
if fmt.Sprint(req.HumanID) == "" {
return nil, errors.New("field HumanID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/test/v1/humans/" + fmt.Sprint(req.HumanID) + "/run",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Human
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type SmokeHumanRequest struct {
// Deprecated: HumanID: UUID of the human you want to make smoking
HumanID *string `json:"-"`
}
// Deprecated: SmokeHuman: make a human smoke
//
// Make a human smoke.
func (s *API) SmokeHuman(req *SmokeHumanRequest, opts ...scw.RequestOption) (*Human, error) {
var err error
if fmt.Sprint(req.HumanID) == "" {
return nil, errors.New("field HumanID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/test/v1/humans/" + fmt.Sprint(req.HumanID) + "/smoke",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Human
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListHumansResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListHumansResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListHumansResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Humans = append(r.Humans, results.Humans...)
r.TotalCount += uint32(len(results.Humans))
return uint32(len(results.Humans)), nil
}
|