feat(instance): add compatible types endpoint and end_of_service flag in ServerType (scaleway#2432)

Author: scaleway-bot

api/instance/v1/instance_sdk.go

@@ -1995,6 +1995,9 @@ type ServerType struct {
 
 	// BlockBandwidth: the maximum bandwidth allocated to block storage access (in bytes per second).
 	BlockBandwidth *uint64 `json:"block_bandwidth"`
+
+	// EndOfService: true if this Instance type has reached end of service.
+	EndOfService bool `json:"end_of_service"`
 }
 
 // VolumeType: volume type.
@@ -2720,6 +2723,15 @@ type GetSecurityGroupRuleResponse struct {
 	Rule *SecurityGroupRule `json:"rule"`
 }
 
+// GetServerCompatibleTypesRequest: get server compatible types request.
+type GetServerCompatibleTypesRequest struct {
+	// Zone: zone to target. If none is passed will use default zone from the config.
+	Zone scw.Zone `json:"-"`
+
+	// ServerID: UUID of the Instance you want to get.
+	ServerID string `json:"-"`
+}
+
 // GetServerRequest: get server request.
 type GetServerRequest struct {
 	// Zone: zone to target. If none is passed will use default zone from the config.
@@ -3475,6 +3487,12 @@ type ServerActionResponse struct {
 	Task *Task `json:"task"`
 }
 
+// ServerCompatibleTypes: server compatible types.
+type ServerCompatibleTypes struct {
+	// CompatibleTypes: instance compatible types.
+	CompatibleTypes []string `json:"compatible_types"`
+}
+
 // SetImageRequest: set image request.
 type SetImageRequest struct {
 	// Zone: zone to target. If none is passed will use default zone from the config.
@@ -4612,6 +4630,42 @@ func (s *API) DeleteServerUserData(req *DeleteServerUserDataRequest, opts ...scw
 	return nil
 }
 
+// GetServerCompatibleTypes: Get compatible commercial types that can be used to update the Instance. The compatibility of an Instance offer is based on:
+// * the CPU architecture
+// * the OS type
+// * the required l_ssd storage size
+// * the required scratch storage size
+// If the specified Instance offer is flagged as end of service, the best compatible offer is the first returned.
+func (s *API) GetServerCompatibleTypes(req *GetServerCompatibleTypesRequest, opts ...scw.RequestOption) (*ServerCompatibleTypes, error) {
+	var err error
+
+	if req.Zone == "" {
+		defaultZone, _ := s.client.GetDefaultZone()
+		req.Zone = defaultZone
+	}
+
+	if fmt.Sprint(req.Zone) == "" {
+		return nil, errors.New("field Zone cannot be empty in request")
+	}
+
+	if fmt.Sprint(req.ServerID) == "" {
+		return nil, errors.New("field ServerID cannot be empty in request")
+	}
+
+	scwReq := &scw.ScalewayRequest{
+		Method: "GET",
+		Path:   "/instance/v1/zones/" + fmt.Sprint(req.Zone) + "/servers/" + fmt.Sprint(req.ServerID) + "/compatible-types",
+	}
+
+	var resp ServerCompatibleTypes
+
+	err = s.client.Do(scwReq, &resp, opts...)
+	if err != nil {
+		return nil, err
+	}
+	return &resp, nil
+}
+
 // AttachServerVolume:
 func (s *API) AttachServerVolume(req *AttachServerVolumeRequest, opts ...scw.RequestOption) (*AttachServerVolumeResponse, error) {
 	var err error