Merge branch 'linode:develop' into develop

packages/api-v4/.changeset/pr-10676-upcoming-features-1721049858027.md

@@ -0,0 +1,5 @@
+---
+"@linode/api-v4": Upcoming Features
+---
+
+Added MetricDefinitions, Dimension, JWETokenPayload, JWEToken and metricDefinitions, dashboard by id and jwe token api calls ([#10676](https://github.com/linode/manager/pull/10676))

packages/api-v4/.changeset/pr-10686-changed-1721191675845.md

@@ -0,0 +1,5 @@
+---
+"@linode/api-v4": Changed
+---
+
+Updated Object Storage types with more descriptive names. ([#10686](https://github.com/linode/manager/pull/10686))

packages/api-v4/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [2024-07-22] - v0.122.0
+
+### Changed:
+
+- Breaking: change Placement Group `affinity_type` to `placement_group_type` ([#10651](https://github.com/linode/manager/pull/10651))
+- Breaking: change Placement Group `is_strict` to `placement_group_policy` ([#10651](https://github.com/linode/manager/pull/10651))
+- Use new "lish" API instead of "lish_token" ([#10656](https://github.com/linode/manager/pull/10656))
+
+### Upcoming Features:
+
+- Add ACLG Config and Widget to CloudPulse types ([#10625](https://github.com/linode/manager/pull/10625))
+
 ## [2024-07-08] - v0.121.0
 
 ### Changed:

packages/api-v4/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linode/api-v4",
-  "version": "0.121.0",
+  "version": "0.122.0",
   "homepage": "https://github.com/linode/manager/tree/develop/packages/api-v4",
   "bugs": {
     "url": "https://github.com/linode/manager/issues"

packages/api-v4/src/cloudpulse/dashboards.ts

@@ -3,9 +3,15 @@ import Request, { setMethod, setURL } from '../request';
 import { Dashboard } from './types';
 import { API_ROOT } from 'src/constants';
 
-//Returns the list of all the dashboards available
+// Returns the list of all the dashboards available
 export const getDashboards = () =>
   Request<ResourcePage<Dashboard>>(
     setURL(`${API_ROOT}/monitor/services/linode/dashboards`),
     setMethod('GET')
   );
+
+export const getDashboardById = (dashboardId: number) =>
+  Request<Dashboard>(
+    setURL(`${API_ROOT}/monitor/dashboards/${encodeURIComponent(dashboardId)}`),
+    setMethod('GET')
+  );

packages/api-v4/src/cloudpulse/index.ts

@@ -1,3 +1,5 @@
 export * from './types';
 
 export * from './dashboards';
+
+export * from './services';

packages/api-v4/src/cloudpulse/services.ts

@@ -0,0 +1,24 @@
+import { API_ROOT } from 'src/constants';
+import Request, { setData, setMethod, setURL } from '../request';
+import { JWEToken, JWETokenPayLoad, MetricDefinitions } from './types';
+import { ResourcePage as Page } from 'src/types';
+
+export const getMetricDefinitionsByServiceType = (serviceType: string) => {
+  return Request<Page<MetricDefinitions>>(
+    setURL(
+      `${API_ROOT}/monitor/services/${encodeURIComponent(
+        serviceType
+      )}/metric-definitions`
+    ),
+    setMethod('GET')
+  );
+};
+
+export const getJWEToken = (data: JWETokenPayLoad, serviceType: string) =>
+  Request<JWEToken>(
+    setURL(
+      `${API_ROOT}/monitor/services/${encodeURIComponent(serviceType)}/token`
+    ),
+    setMethod('POST'),
+    setData(data)
+  );

packages/api-v4/src/cloudpulse/types.ts

@@ -59,3 +59,31 @@ export interface AclpWidget {
   label: string;
   size: number;
 }
+
+export interface MetricDefinitions {
+  data: AvailableMetrics[];
+}
+
+export interface AvailableMetrics {
+  label: string;
+  metric: string;
+  metric_type: string;
+  unit: string;
+  scrape_interval: string;
+  available_aggregate_functions: string[];
+  dimensions: Dimension[];
+}
+
+export interface Dimension {
+  label: string;
+  dimension_label: string;
+  values: string[];
+}
+
+export interface JWETokenPayLoad {
+  resource_id: string[];
+}
+
+export interface JWEToken{
+  token: string;
+}

packages/api-v4/src/object-storage/buckets.ts

@@ -14,14 +14,14 @@ import Request, {
 import { Filter, Params, ResourcePage as Page } from '../types';
 import {
   ObjectStorageBucket,
-  ObjectStorageBucketAccessRequest,
-  ObjectStorageBucketAccessResponse,
-  ObjectStorageBucketRequestPayload,
-  ObjectStorageBucketSSLRequest,
-  ObjectStorageBucketSSLResponse,
-  ObjectStorageDeleteBucketRequestPayload,
-  ObjectStorageObjectListParams,
-  ObjectStorageObjectListResponse,
+  UpdateObjectStorageBucketAccessPayload,
+  ObjectStorageBucketAccess,
+  CreateObjectStorageBucketPayload,
+  CreateObjectStorageBucketSSLPayload,
+  ObjectStorageBucketSSL,
+  DeleteObjectStorageBucketPayload,
+  GetObjectStorageObjectListPayload,
+  ObjectStorageObjectList,
 } from './types';
 
 /**
@@ -96,7 +96,7 @@ export const getBucketsInRegion = (
  * @param data { object } The label and clusterId of the new Bucket.
  *
  */
-export const createBucket = (data: ObjectStorageBucketRequestPayload) =>
+export const createBucket = (data: CreateObjectStorageBucketPayload) =>
   Request<ObjectStorageBucket>(
     setURL(`${API_ROOT}/object-storage/buckets`),
     setMethod('POST'),
@@ -113,7 +113,7 @@ export const createBucket = (data: ObjectStorageBucketRequestPayload) =>
 export const deleteBucket = ({
   cluster,
   label,
-}: ObjectStorageDeleteBucketRequestPayload) =>
+}: DeleteObjectStorageBucketPayload) =>
   Request<ObjectStorageBucket>(
     setURL(
       `${API_ROOT}/object-storage/buckets/${encodeURIComponent(
@@ -155,12 +155,12 @@ export const deleteBucketWithRegion = ({
 /**
  * Returns a list of Objects in a given Bucket.
  */
-export const getObjectList = (
-  clusterId: string,
-  bucketName: string,
-  params?: ObjectStorageObjectListParams
-) =>
-  Request<ObjectStorageObjectListResponse>(
+export const getObjectList = ({
+  clusterId,
+  bucket: bucketName,
+  params,
+}: GetObjectStorageObjectListPayload) =>
+  Request<ObjectStorageObjectList>(
     setMethod('GET'),
     setParams(params),
     setURL(
@@ -176,9 +176,9 @@ export const getObjectList = (
 export const uploadSSLCert = (
   clusterId: string,
   bucketName: string,
-  data: ObjectStorageBucketSSLRequest
+  data: CreateObjectStorageBucketSSLPayload
 ) =>
-  Request<ObjectStorageBucketSSLResponse>(
+  Request<ObjectStorageBucketSSL>(
     setMethod('POST'),
     setData(data, UploadCertificateSchema),
     setURL(
@@ -195,7 +195,7 @@ export const uploadSSLCert = (
  * the specified bucket, { ssl: false } otherwise.
  */
 export const getSSLCert = (clusterId: string, bucketName: string) =>
-  Request<ObjectStorageBucketSSLResponse>(
+  Request<ObjectStorageBucketSSL>(
     setMethod('GET'),
     setURL(
       `${API_ROOT}/object-storage/buckets/${encodeURIComponent(
@@ -227,7 +227,7 @@ export const deleteSSLCert = (clusterId: string, bucketName: string) =>
  * Returns access information (ACL, CORS) for a given Bucket.
  */
 export const getBucketAccess = (clusterId: string, bucketName: string) =>
-  Request<ObjectStorageBucketAccessResponse>(
+  Request<ObjectStorageBucketAccess>(
     setMethod('GET'),
     setURL(
       `${API_ROOT}/object-storage/buckets/${encodeURIComponent(
@@ -244,7 +244,7 @@ export const getBucketAccess = (clusterId: string, bucketName: string) =>
 export const updateBucketAccess = (
   clusterId: string,
   bucketName: string,
-  data: ObjectStorageBucketAccessRequest
+  params: UpdateObjectStorageBucketAccessPayload
 ) =>
   Request<{}>(
     setMethod('PUT'),
@@ -253,5 +253,5 @@ export const updateBucketAccess = (
         clusterId
       )}/${encodeURIComponent(bucketName)}/access`
     ),
-    setData(data, UpdateBucketAccessSchema)
+    setData(params, UpdateBucketAccessSchema)
   );

packages/api-v4/src/object-storage/objectStorageKeys.ts

@@ -13,8 +13,8 @@ import Request, {
 import { Filter, Params, ResourcePage as Page } from '../types';
 import {
   ObjectStorageKey,
-  ObjectStorageKeyRequest,
-  UpdateObjectStorageKeyRequest,
+  CreateObjectStorageKeyPayload,
+  UpdateObjectStorageKeyPayload,
 } from './types';
 
 /**
@@ -35,7 +35,7 @@ export const getObjectStorageKeys = (params?: Params, filters?: Filter) =>
  *
  * Creates an Object Storage key
  */
-export const createObjectStorageKeys = (data: ObjectStorageKeyRequest) =>
+export const createObjectStorageKeys = (data: CreateObjectStorageKeyPayload) =>
   Request<ObjectStorageKey>(
     setMethod('POST'),
     setURL(`${API_ROOT}/object-storage/keys`),
@@ -49,7 +49,7 @@ export const createObjectStorageKeys = (data: ObjectStorageKeyRequest) =>
  */
 export const updateObjectStorageKey = (
   id: number,
-  data: UpdateObjectStorageKeyRequest
+  data: UpdateObjectStorageKeyPayload
 ) =>
   Request<ObjectStorageKey>(
     setMethod('PUT'),

packages/api-v4/src/object-storage/objects.ts

@@ -8,23 +8,26 @@ import Request, {
 } from '../request';
 import {
   ACLType,
-  ObjectStorageEndpointsResponse,
+  ObjectStorageEndpoint,
   ObjectStorageObjectACL,
   ObjectStorageObjectURL,
-  ObjectStorageObjectURLOptions,
+  GetObjectStorageACLPayload,
+  CreateObjectStorageObjectURLPayload,
 } from './types';
 
 import type { ResourcePage, RequestOptions } from '../types';
 
 /**
- * Gets a URL to upload/download/delete Objects from a Bucket.
+ * Creates a pre-signed URL to access a single object in a bucket.
+ * Use it to share, create, or delete objects by using the appropriate
+ * HTTP method in your request body's method parameter.
  */
 export const getObjectURL = (
   clusterId: string,
   bucketName: string,
   name: string,
   method: 'GET' | 'PUT' | 'POST' | 'DELETE',
-  options?: ObjectStorageObjectURLOptions
+  options?: CreateObjectStorageObjectURLPayload
 ) =>
   Request<ObjectStorageObjectURL>(
     setMethod('POST'),
@@ -42,18 +45,18 @@ export const getObjectURL = (
  *
  * Gets the ACL for a given Object.
  */
-export const getObjectACL = (
-  clusterId: string,
-  bucketName: string,
-  name: string
-) =>
+export const getObjectACL = ({
+  clusterId,
+  bucket,
+  params,
+}: GetObjectStorageACLPayload) =>
   Request<ObjectStorageObjectACL>(
     setMethod('GET'),
     setURL(
       `${API_ROOT}/object-storage/buckets/${encodeURIComponent(
         clusterId
-      )}/${encodeURIComponent(bucketName)}/object-acl?name=${encodeURIComponent(
-        name
+      )}/${encodeURIComponent(bucket)}/object-acl?name=${encodeURIComponent(
+        params.name
       )}`
     )
   );
@@ -81,7 +84,7 @@ export const updateObjectACL = (
   );
 
 export const getObjectStorageEndpoints = ({ filter, params }: RequestOptions) =>
-  Request<ResourcePage<ObjectStorageEndpointsResponse[]>>(
+  Request<ResourcePage<ObjectStorageEndpoint>>(
     setMethod('GET'),
     setURL(`${API_ROOT}/object-storage/endpoints`),
     setParams(params),