@scaleway/sdk-file 1.0.5 → 1.0.6

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.
@@ -56,12 +56,11 @@ class API extends sdkClient.API {
56
56
  marshalling_gen.unmarshalListFileSystemsResponse
57
57
  );
58
58
  /**
59
- * List all filesystems. Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
60
- Use the order_by parameter to modify the sorting behavior.
61
- *
62
- * @param request - The request {@link ListFileSystemsRequest}
63
- * @returns A Promise of ListFileSystemsResponse
64
- */
59
+ * List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
60
+ *
61
+ * @param request - The request {@link ListFileSystemsRequest}
62
+ * @returns A Promise of ListFileSystemsResponse
63
+ */
65
64
  listFileSystems = (request = {}) => sdkClient.enrichForPagination("filesystems", this.pageOfListFileSystems, request);
66
65
  pageOfListAttachments = (request = {}) => this.client.fetch(
67
66
  {
@@ -83,15 +82,14 @@ class API extends sdkClient.API {
83
82
  );
84
83
  /**
85
84
  * List filesystems attachments. List all existing attachments in a specified region.
86
- By default, the attachments listed are ordered by creation date in ascending order.
87
- This can be modified using the `order_by` field.
85
+ By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
88
86
  *
89
87
  * @param request - The request {@link ListAttachmentsRequest}
90
88
  * @returns A Promise of ListAttachmentsResponse
91
89
  */
92
90
  listAttachments = (request = {}) => sdkClient.enrichForPagination("attachments", this.pageOfListAttachments, request);
93
91
  /**
94
- * Create a new filesystem. To create a new filesystem, you need to provide a name, a size, and a project ID.
92
+ * Create a new filesystem. To create a new filesystem, you must specify a name, a size, and a project ID.
95
93
  *
96
94
  * @param request - The request {@link CreateFileSystemRequest}
97
95
  * @returns A Promise of FileSystem
@@ -26,8 +26,7 @@ export declare class API extends ParentAPI {
26
26
  waitForFileSystem: (request: Readonly<GetFileSystemRequest>, options?: Readonly<WaitForOptions<FileSystem>>) => Promise<FileSystem>;
27
27
  protected pageOfListFileSystems: (request?: Readonly<ListFileSystemsRequest>) => Promise<ListFileSystemsResponse>;
28
28
  /**
29
- * List all filesystems. Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
30
- Use the order_by parameter to modify the sorting behavior.
29
+ * List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
31
30
  *
32
31
  * @param request - The request {@link ListFileSystemsRequest}
33
32
  * @returns A Promise of ListFileSystemsResponse
@@ -39,8 +38,7 @@ export declare class API extends ParentAPI {
39
38
  protected pageOfListAttachments: (request?: Readonly<ListAttachmentsRequest>) => Promise<ListAttachmentsResponse>;
40
39
  /**
41
40
  * List filesystems attachments. List all existing attachments in a specified region.
42
- By default, the attachments listed are ordered by creation date in ascending order.
43
- This can be modified using the `order_by` field.
41
+ By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
44
42
  *
45
43
  * @param request - The request {@link ListAttachmentsRequest}
46
44
  * @returns A Promise of ListAttachmentsResponse
@@ -50,7 +48,7 @@ export declare class API extends ParentAPI {
50
48
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Attachment[], void, void>;
51
49
  };
52
50
  /**
53
- * Create a new filesystem. To create a new filesystem, you need to provide a name, a size, and a project ID.
51
+ * Create a new filesystem. To create a new filesystem, you must specify a name, a size, and a project ID.
54
52
  *
55
53
  * @param request - The request {@link CreateFileSystemRequest}
56
54
  * @returns A Promise of FileSystem
@@ -54,12 +54,11 @@ class API extends API$1 {
54
54
  unmarshalListFileSystemsResponse
55
55
  );
56
56
  /**
57
- * List all filesystems. Retrieve all filesystems in the specified region. Results are ordered by creation date in ascending order by default.
58
- Use the order_by parameter to modify the sorting behavior.
59
- *
60
- * @param request - The request {@link ListFileSystemsRequest}
61
- * @returns A Promise of ListFileSystemsResponse
62
- */
57
+ * List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
58
+ *
59
+ * @param request - The request {@link ListFileSystemsRequest}
60
+ * @returns A Promise of ListFileSystemsResponse
61
+ */
63
62
  listFileSystems = (request = {}) => enrichForPagination("filesystems", this.pageOfListFileSystems, request);
64
63
  pageOfListAttachments = (request = {}) => this.client.fetch(
65
64
  {
@@ -81,15 +80,14 @@ class API extends API$1 {
81
80
  );
82
81
  /**
83
82
  * List filesystems attachments. List all existing attachments in a specified region.
84
- By default, the attachments listed are ordered by creation date in ascending order.
85
- This can be modified using the `order_by` field.
83
+ By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the `order_by` field.
86
84
  *
87
85
  * @param request - The request {@link ListAttachmentsRequest}
88
86
  * @returns A Promise of ListAttachmentsResponse
89
87
  */
90
88
  listAttachments = (request = {}) => enrichForPagination("attachments", this.pageOfListAttachments, request);
91
89
  /**
92
- * Create a new filesystem. To create a new filesystem, you need to provide a name, a size, and a project ID.
90
+ * Create a new filesystem. To create a new filesystem, you must specify a name, a size, and a project ID.
93
91
  *
94
92
  * @param request - The request {@link CreateFileSystemRequest}
95
93
  * @returns A Promise of FileSystem
@@ -198,7 +198,7 @@ export type ListFileSystemsRequest = {
198
198
  */
199
199
  pageSize?: number;
200
200
  /**
201
- * Filter the return filesystems by their names.
201
+ * Filter the returned filesystems by their names.
202
202
  */
203
203
  name?: string;
204
204
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scaleway/sdk-file",
3
- "version": "1.0.5",
3
+ "version": "1.0.6",
4
4
  "description": "Scaleway SDK file",
5
5
  "types": "dist/index.d.ts",
6
6
  "files": [