@scaleway/sdk-ipam 2.3.2 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -52,21 +52,21 @@ export declare class API extends ParentAPI {
52
52
  [Symbol.asyncIterator]: () => AsyncGenerator<IP[], void, void>;
53
53
  };
54
54
  /**
55
- * Attach IP to custom resource. Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
55
+ * Attach private IP to custom resource. Attach an existing reserved private IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
56
56
  *
57
57
  * @param request - The request {@link AttachIPRequest}
58
58
  * @returns A Promise of IP
59
59
  */
60
60
  attachIP: (request: Readonly<AttachIPRequest>) => Promise<IP>;
61
61
  /**
62
- * Detach IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
62
+ * Detach private IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
63
63
  *
64
64
  * @param request - The request {@link DetachIPRequest}
65
65
  * @returns A Promise of IP
66
66
  */
67
67
  detachIP: (request: Readonly<DetachIPRequest>) => Promise<IP>;
68
68
  /**
69
- * Move IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
69
+ * Move private IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
70
70
  *
71
71
  * @param request - The request {@link MoveIPRequest}
72
72
  * @returns A Promise of IP
@@ -98,7 +98,7 @@ var API = class extends API$1 {
98
98
  */
99
99
  listIPs = (request = {}) => enrichForPagination("ips", this.pageOfListIPs, request);
100
100
  /**
101
- * Attach IP to custom resource. Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
101
+ * Attach private IP to custom resource. Attach an existing reserved private IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method.
102
102
  *
103
103
  * @param request - The request {@link AttachIPRequest}
104
104
  * @returns A Promise of IP
@@ -110,7 +110,7 @@ var API = class extends API$1 {
110
110
  path: `/ipam/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/ips/${validatePathParam("ipId", request.ipId)}/attach`
111
111
  }, unmarshalIP);
112
112
  /**
113
- * Detach IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
113
+ * Detach private IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
114
114
  *
115
115
  * @param request - The request {@link DetachIPRequest}
116
116
  * @returns A Promise of IP
@@ -122,7 +122,7 @@ var API = class extends API$1 {
122
122
  path: `/ipam/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/ips/${validatePathParam("ipId", request.ipId)}/detach`
123
123
  }, unmarshalIP);
124
124
  /**
125
- * Move IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
125
+ * Move private IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method.
126
126
  *
127
127
  * @param request - The request {@link MoveIPRequest}
128
128
  * @returns A Promise of IP
@@ -0,0 +1,30 @@
1
+ export declare const queriesMetadata: {
2
+ readonly namespace: "ipam";
3
+ readonly version: "v1";
4
+ readonly folderName: "ipamv1";
5
+ readonly services: readonly [{
6
+ readonly apiClass: "API";
7
+ readonly methods: readonly [{
8
+ readonly methodName: "getIP";
9
+ readonly protoName: "GetIP";
10
+ readonly paramsType: "GetIPRequest";
11
+ readonly returnType: "IP";
12
+ readonly isList: false;
13
+ readonly paginationType: "none";
14
+ readonly isPrivate: false;
15
+ readonly description: "\"";
16
+ }, {
17
+ readonly methodName: "listIPs";
18
+ readonly protoName: "ListIPs";
19
+ readonly paramsType: "ListIPsRequest";
20
+ readonly returnType: "ListIPsResponse";
21
+ readonly isList: true;
22
+ readonly paginationType: "offset";
23
+ readonly pageParamKey: "page";
24
+ readonly listItemType: "IP";
25
+ readonly isPrivate: false;
26
+ readonly description: "\"";
27
+ }];
28
+ }];
29
+ };
30
+ export type QueriesMetadata = typeof queriesMetadata;
@@ -0,0 +1,32 @@
1
+ //#region src/v1/metadata.gen.ts
2
+ var queriesMetadata = {
3
+ namespace: "ipam",
4
+ version: "v1",
5
+ folderName: "ipamv1",
6
+ services: [{
7
+ apiClass: "API",
8
+ methods: [{
9
+ methodName: "getIP",
10
+ protoName: "GetIP",
11
+ paramsType: "GetIPRequest",
12
+ returnType: "IP",
13
+ isList: false,
14
+ paginationType: "none",
15
+ isPrivate: false,
16
+ description: "\""
17
+ }, {
18
+ methodName: "listIPs",
19
+ protoName: "ListIPs",
20
+ paramsType: "ListIPsRequest",
21
+ returnType: "ListIPsResponse",
22
+ isList: true,
23
+ paginationType: "offset",
24
+ pageParamKey: "page",
25
+ listItemType: "IP",
26
+ isPrivate: false,
27
+ description: "\""
28
+ }]
29
+ }]
30
+ };
31
+ //#endregion
32
+ export { queriesMetadata };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk-ipam",
3
- "version": "2.3.2",
3
+ "version": "2.4.0",
4
4
  "description": "Scaleway SDK ipam",
5
5
  "license": "Apache-2.0",
6
6
  "files": [