@maxim_mazurok/gapi.client.cloudresourcemanager-v3 0.3.20261021 → 0.3.20261107

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.
Files changed (3) hide show
  1. package/index.d.ts +14 -12
  2. package/package.json +1 -1
  3. package/readme.md +11 -11
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v3
12
- // Revision: 20261021
12
+ // Revision: 20261107
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -396,6 +396,8 @@ declare namespace gapi.client {
396
396
  isManagementProject?: boolean;
397
397
  /** Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"myBusinessDimension" : "businessValue"` */
398
398
  labels?: {[P in string]: string};
399
+ /** Output only. The type of Management Project. This field is only populated if `is_management_project` is `true`. */
400
+ managementType?: 'MANAGEMENT_TYPE_UNSPECIFIED' | 'SELF_MANAGED' | 'HUB';
399
401
  /** Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/". Example: `projects/415104041262` */
400
402
  name?: string;
401
403
  /** Optional. A reference to a parent Resource. eg., `organizations/123` or `folders/876`. */
@@ -1418,7 +1420,7 @@ declare namespace gapi.client {
1418
1420
  },
1419
1421
  body: Folder,
1420
1422
  ): Request<Operation>;
1421
- /** Search for folders that match specific filter criteria. `search()` provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. */
1423
+ /** Searches for folders that match specific filter criteria. `search()` provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`. */
1422
1424
  search(request?: {
1423
1425
  /** V1 error format. */
1424
1426
  '$.xgafv'?: '1' | '2';
@@ -1634,7 +1636,7 @@ declare namespace gapi.client {
1634
1636
  capabilityConfigs: CapabilityConfigsResource;
1635
1637
  }
1636
1638
  interface LiensResource {
1637
- /** Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied. */
1639
+ /** Creates a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied. */
1638
1640
  create(request: {
1639
1641
  /** V1 error format. */
1640
1642
  '$.xgafv'?: '1' | '2';
@@ -1688,7 +1690,7 @@ declare namespace gapi.client {
1688
1690
  },
1689
1691
  body: Lien,
1690
1692
  ): Request<Lien>;
1691
- /** Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`. */
1693
+ /** Deletes a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`. */
1692
1694
  delete(request?: {
1693
1695
  /** V1 error format. */
1694
1696
  '$.xgafv'?: '1' | '2';
@@ -1715,7 +1717,7 @@ declare namespace gapi.client {
1715
1717
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1716
1718
  uploadType?: string;
1717
1719
  }): Request<{}>;
1718
- /** Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get` */
1720
+ /** Retrieves a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get` */
1719
1721
  get(request?: {
1720
1722
  /** V1 error format. */
1721
1723
  '$.xgafv'?: '1' | '2';
@@ -1742,7 +1744,7 @@ declare namespace gapi.client {
1742
1744
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1743
1745
  uploadType?: string;
1744
1746
  }): Request<Lien>;
1745
- /** List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`. */
1747
+ /** Lists all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`. */
1746
1748
  list(request?: {
1747
1749
  /** V1 error format. */
1748
1750
  '$.xgafv'?: '1' | '2';
@@ -2802,7 +2804,7 @@ declare namespace gapi.client {
2802
2804
  ): Request<Operation>;
2803
2805
  }
2804
2806
  interface ProjectsResource {
2805
- /** Request that a new project be created. The result is an `Operation` which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking `Operation` is automatically deleted after a few hours, so there is no need to call `DeleteOperation`. */
2807
+ /** Requests that a new project be created. The result is an `Operation` which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking `Operation` is automatically deleted after a few hours, so there is no need to call `DeleteOperation`. */
2806
2808
  create(request: {
2807
2809
  /** V1 error format. */
2808
2810
  '$.xgafv'?: '1' | '2';
@@ -2910,7 +2912,7 @@ declare namespace gapi.client {
2910
2912
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2911
2913
  uploadType?: string;
2912
2914
  }): Request<Project>;
2913
- /** Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. Permission is denied if the policy or the resource do not exist. */
2915
+ /** Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}`, for example, `projects/123`. Permission is denied if the policy or the resource do not exist. */
2914
2916
  getIamPolicy(
2915
2917
  request: {
2916
2918
  /** V1 error format. */
@@ -2973,7 +2975,7 @@ declare namespace gapi.client {
2973
2975
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2974
2976
  uploadType?: string;
2975
2977
  }): Request<ListProjectsResponse>;
2976
- /** Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project. */
2978
+ /** Moves a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project. */
2977
2979
  move(request: {
2978
2980
  /** V1 error format. */
2979
2981
  '$.xgafv'?: '1' | '2';
@@ -3093,7 +3095,7 @@ declare namespace gapi.client {
3093
3095
  },
3094
3096
  body: Project,
3095
3097
  ): Request<Operation>;
3096
- /** Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. */
3098
+ /** Searches for projects on which the caller has the `resourcemanager.projects.get` permission and that match the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method. */
3097
3099
  search(request?: {
3098
3100
  /** V1 error format. */
3099
3101
  '$.xgafv'?: '1' | '2';
@@ -3124,7 +3126,7 @@ declare namespace gapi.client {
3124
3126
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3125
3127
  uploadType?: string;
3126
3128
  }): Request<SearchProjectsResponse>;
3127
- /** Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. */
3129
+ /** Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}`, for example, `projects/123`. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible. */
3128
3130
  setIamPolicy(
3129
3131
  request: {
3130
3132
  /** V1 error format. */
@@ -3154,7 +3156,7 @@ declare namespace gapi.client {
3154
3156
  },
3155
3157
  body: SetIamPolicyRequest,
3156
3158
  ): Request<Policy>;
3157
- /** Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123.. */
3159
+ /** Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}`, for example, `projects/123`. */
3158
3160
  testIamPermissions(
3159
3161
  request: {
3160
3162
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.cloudresourcemanager-v3",
3
- "version": "0.3.20261021",
3
+ "version": "0.3.20261107",
4
4
  "description": "TypeScript typings for Cloud Resource Manager API v3",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -139,7 +139,7 @@ Updates a folder, changing its `display_name`. Changes to the folder `display_na
139
139
  await gapi.client.cloudresourcemanager.folders.patch({name: 'name'});
140
140
 
141
141
  /*
142
- Search for folders that match specific filter criteria. `search()` provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`.
142
+ Searches for folders that match specific filter criteria. `search()` provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria. This will only return folders on which the caller has the permission `resourcemanager.folders.get`.
143
143
  */
144
144
  await gapi.client.cloudresourcemanager.folders.search({});
145
145
 
@@ -170,22 +170,22 @@ await gapi.client.cloudresourcemanager.folders.updateBoundaryConfig({
170
170
  });
171
171
 
172
172
  /*
173
- Create a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied.
173
+ Creates a Lien which applies to the resource denoted by the `parent` field. Callers of this method will require permission on the `parent` resource. For example, applying to `projects/1234` requires permission `resourcemanager.projects.updateLiens`. NOTE: Some resources may limit the number of Liens which may be applied.
174
174
  */
175
175
  await gapi.client.cloudresourcemanager.liens.create({});
176
176
 
177
177
  /*
178
- Delete a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`.
178
+ Deletes a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.updateLiens`.
179
179
  */
180
180
  await gapi.client.cloudresourcemanager.liens.delete({name: 'name'});
181
181
 
182
182
  /*
183
- Retrieve a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`
183
+ Retrieves a Lien by `name`. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`
184
184
  */
185
185
  await gapi.client.cloudresourcemanager.liens.get({name: 'name'});
186
186
 
187
187
  /*
188
- List all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`.
188
+ Lists all Liens applied to the `parent` resource. Callers of this method will require permission on the `parent` resource. For example, a Lien with a `parent` of `projects/1234` requires permission `resourcemanager.projects.get`.
189
189
  */
190
190
  await gapi.client.cloudresourcemanager.liens.list({});
191
191
 
@@ -240,7 +240,7 @@ await gapi.client.cloudresourcemanager.organizations.updateBoundaryConfig({
240
240
  });
241
241
 
242
242
  /*
243
- Request that a new project be created. The result is an `Operation` which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking `Operation` is automatically deleted after a few hours, so there is no need to call `DeleteOperation`.
243
+ Requests that a new project be created. The result is an `Operation` which can be used to track the creation process. This process usually takes a few seconds, but can sometimes take much longer. The tracking `Operation` is automatically deleted after a few hours, so there is no need to call `DeleteOperation`.
244
244
  */
245
245
  await gapi.client.cloudresourcemanager.projects.create({});
246
246
 
@@ -255,7 +255,7 @@ Retrieves the project identified by the specified `name` (for example, `projects
255
255
  await gapi.client.cloudresourcemanager.projects.get({name: 'name'});
256
256
 
257
257
  /*
258
- Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. Permission is denied if the policy or the resource do not exist.
258
+ Returns the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}`, for example, `projects/123`. Permission is denied if the policy or the resource do not exist.
259
259
  */
260
260
  await gapi.client.cloudresourcemanager.projects.getIamPolicy({
261
261
  resource: 'resource',
@@ -267,7 +267,7 @@ Lists projects that are direct children of the specified folder or organization
267
267
  await gapi.client.cloudresourcemanager.projects.list({});
268
268
 
269
269
  /*
270
- Move a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project.
270
+ Moves a project to another place in your resource hierarchy, under a new resource parent. Returns an operation which can be used to track the process of the project move workflow. Upon success, the `Operation.response` field will be populated with the moved project. The caller must have `resourcemanager.projects.move` permission on the project, on the project's current and proposed new parent. If project has no current parent, or it currently does not have an associated organization resource, you will also need the `resourcemanager.projects.setIamPolicy` permission in the project.
271
271
  */
272
272
  await gapi.client.cloudresourcemanager.projects.move({name: 'name'});
273
273
 
@@ -277,19 +277,19 @@ Updates the `display_name` and labels of the project identified by the specified
277
277
  await gapi.client.cloudresourcemanager.projects.patch({name: 'name'});
278
278
 
279
279
  /*
280
- Search for projects that the caller has the `resourcemanager.projects.get` permission on, and also satisfy the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method.
280
+ Searches for projects on which the caller has the `resourcemanager.projects.get` permission and that match the specified query. This method returns projects in an unspecified order. This method is eventually consistent with project mutations; this means that a newly created project may not appear in the results or recent updates to an existing project may not be reflected in the results. To retrieve the latest state of a project, use the GetProject method.
281
281
  */
282
282
  await gapi.client.cloudresourcemanager.projects.search({});
283
283
 
284
284
  /*
285
- Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.
285
+ Sets the IAM access control policy for the specified project, in the format `projects/{ProjectIdOrNumber}`, for example, `projects/123`. CAUTION: This method will replace the existing policy, and cannot be used to append additional IAM settings. Note: Removing service accounts from policies or changing their roles can render services completely inoperable. It is important to understand how the service account is being used before removing or updating its roles. The following constraints apply when using `setIamPolicy()`: + Project does not support `allUsers` and `allAuthenticatedUsers` as `members` in a `Binding` of a `Policy`. + The owner role can be granted to a `user`, `serviceAccount`, or a group that is part of an organization. For example, group@myownpersonaldomain.com could be added as an owner to a project in the myownpersonaldomain.com organization, but not the examplepetstore.com organization. + Service accounts can be made owners of a project directly without any restrictions. However, to be added as an owner, a user must be invited using the Cloud Platform console and must accept the invitation. + A user cannot be granted the owner role using `setIamPolicy()`. The user must be granted the owner role using the Cloud Platform Console and must explicitly accept the invitation. + Invitations to grant the owner role cannot be sent using `setIamPolicy()`; they must be sent only using the Cloud Platform Console. + If the project is not part of an organization, there must be at least one owner who has accepted the Terms of Service (ToS) agreement in the policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner from the policy will fail. This restriction also applies to legacy projects that no longer have owners who have accepted the ToS. Edits to IAM policies will be rejected until the lack of a ToS-accepting owner is rectified. If the project is part of an organization, you can remove all owners, potentially making the organization inaccessible.
286
286
  */
287
287
  await gapi.client.cloudresourcemanager.projects.setIamPolicy({
288
288
  resource: 'resource',
289
289
  });
290
290
 
291
291
  /*
292
- Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}` e.g. projects/123..
292
+ Returns permissions that a caller has on the specified project, in the format `projects/{ProjectIdOrNumber}`, for example, `projects/123`.
293
293
  */
294
294
  await gapi.client.cloudresourcemanager.projects.testIamPermissions({
295
295
  resource: 'resource',