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
|
// This file was automatically generated. DO NOT EDIT.
// If you have any remark or suggestion do not hesitate to open an issue.
// Package account provides methods and message types of the account v2 API.
package account
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: user related data
//
// This API allows you to manage projects.
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 ListProjectsRequestOrderBy string
const (
// ListProjectsRequestOrderByCreatedAtAsc is [insert doc].
ListProjectsRequestOrderByCreatedAtAsc = ListProjectsRequestOrderBy("created_at_asc")
// ListProjectsRequestOrderByCreatedAtDesc is [insert doc].
ListProjectsRequestOrderByCreatedAtDesc = ListProjectsRequestOrderBy("created_at_desc")
// ListProjectsRequestOrderByNameAsc is [insert doc].
ListProjectsRequestOrderByNameAsc = ListProjectsRequestOrderBy("name_asc")
// ListProjectsRequestOrderByNameDesc is [insert doc].
ListProjectsRequestOrderByNameDesc = ListProjectsRequestOrderBy("name_desc")
)
func (enum ListProjectsRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListProjectsRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListProjectsRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListProjectsRequestOrderBy(ListProjectsRequestOrderBy(tmp).String())
return nil
}
// ListProjectsResponse: list projects response
type ListProjectsResponse struct {
// TotalCount: the total number of projects
TotalCount uint32 `json:"total_count"`
// Projects: the paginated returned projects
Projects []*Project `json:"projects"`
}
// Project: project
type Project struct {
// ID: the ID of the project
ID string `json:"id"`
// Name: the name of the project
Name string `json:"name"`
// OrganizationID: the organization ID of the project
OrganizationID string `json:"organization_id"`
// CreatedAt: the creation date of the project
CreatedAt *time.Time `json:"created_at"`
// UpdatedAt: the update date of the project
UpdatedAt *time.Time `json:"updated_at"`
// Description: the description of the project
Description string `json:"description"`
}
// Service API
type CreateProjectRequest struct {
// Name: the name of the project
Name string `json:"name"`
// OrganizationID: the organization ID of the project
OrganizationID string `json:"organization_id"`
// Description: the description of the project
Description *string `json:"description"`
}
// CreateProject: create project
func (s *API) CreateProject(req *CreateProjectRequest, opts ...scw.RequestOption) (*Project, error) {
var err error
if req.OrganizationID == "" {
defaultOrganizationID, _ := s.client.GetDefaultOrganizationID()
req.OrganizationID = defaultOrganizationID
}
scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/account/v2/projects",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Project
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListProjectsRequest struct {
// OrganizationID: the organization ID of the project
OrganizationID string `json:"-"`
// Name: the name of the project
Name *string `json:"-"`
// Page: the page number for the returned projects
Page *int32 `json:"-"`
// PageSize: the maximum number of project per page
PageSize *uint32 `json:"-"`
// OrderBy: the sort order of the returned projects
//
// Default value: created_at_asc
OrderBy ListProjectsRequestOrderBy `json:"-"`
// ProjectIDs: filter out by a list of project ID
ProjectIDs []string `json:"-"`
}
// ListProjects: list projects
func (s *API) ListProjects(req *ListProjectsRequest, opts ...scw.RequestOption) (*ListProjectsResponse, error) {
var err error
if req.OrganizationID == "" {
defaultOrganizationID, _ := s.client.GetDefaultOrganizationID()
req.OrganizationID = defaultOrganizationID
}
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "organization_id", req.OrganizationID)
parameter.AddToQuery(query, "name", req.Name)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "order_by", req.OrderBy)
parameter.AddToQuery(query, "project_ids", req.ProjectIDs)
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/account/v2/projects",
Query: query,
Headers: http.Header{},
}
var resp ListProjectsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetProjectRequest struct {
// ProjectID: the project ID of the project
ProjectID string `json:"-"`
}
// GetProject: get project
func (s *API) GetProject(req *GetProjectRequest, opts ...scw.RequestOption) (*Project, error) {
var err error
if req.ProjectID == "" {
defaultProjectID, _ := s.client.GetDefaultProjectID()
req.ProjectID = defaultProjectID
}
if fmt.Sprint(req.ProjectID) == "" {
return nil, errors.New("field ProjectID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/account/v2/projects/" + fmt.Sprint(req.ProjectID) + "",
Headers: http.Header{},
}
var resp Project
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type DeleteProjectRequest struct {
// ProjectID: the project ID of the project
ProjectID string `json:"-"`
}
// DeleteProject: delete project
func (s *API) DeleteProject(req *DeleteProjectRequest, opts ...scw.RequestOption) error {
var err error
if req.ProjectID == "" {
defaultProjectID, _ := s.client.GetDefaultProjectID()
req.ProjectID = defaultProjectID
}
if fmt.Sprint(req.ProjectID) == "" {
return errors.New("field ProjectID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "DELETE",
Path: "/account/v2/projects/" + fmt.Sprint(req.ProjectID) + "",
Headers: http.Header{},
}
err = s.client.Do(scwReq, nil, opts...)
if err != nil {
return err
}
return nil
}
type UpdateProjectRequest struct {
// ProjectID: the project ID of the project
ProjectID string `json:"-"`
// Name: the name of the project
Name *string `json:"name"`
// Description: the description of the project
Description *string `json:"description"`
}
// UpdateProject: update project
func (s *API) UpdateProject(req *UpdateProjectRequest, opts ...scw.RequestOption) (*Project, error) {
var err error
if req.ProjectID == "" {
defaultProjectID, _ := s.client.GetDefaultProjectID()
req.ProjectID = defaultProjectID
}
if fmt.Sprint(req.ProjectID) == "" {
return nil, errors.New("field ProjectID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "PATCH",
Path: "/account/v2/projects/" + fmt.Sprint(req.ProjectID) + "",
Headers: http.Header{},
}
err = scwReq.SetBody(req)
if err != nil {
return nil, err
}
var resp Project
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 *ListProjectsResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListProjectsResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListProjectsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Projects = append(r.Projects, results.Projects...)
r.TotalCount += uint32(len(results.Projects))
return uint32(len(results.Projects)), nil
}
|