addPermissions(matterId=*, body=None, x__xgafv=None)

Adds an account as a matter collaborator.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Add an account with the permission specified. The role cannot be owner.
      # If an account already has a role in the matter, it will be
      # overwritten.
    "ccMe": True or False, # Only relevant if send_emails is true.
        # True to CC requestor in the email message.
        # False to not CC requestor.
    "sendEmails": True or False, # True to send notification email to the added account.
        # False to not send notification email.
    "matterPermission": { # Currently each matter only has one owner, and all others are collaborators. # The MatterPermission to add.
        # When an account is purged, its corresponding MatterPermission resources
        # cease to exist.
      "role": "A String", # The user's role in this matter.
      "accountId": "A String", # The account id, as provided by <a
          # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
    },
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Currently each matter only has one owner, and all others are collaborators.
      # When an account is purged, its corresponding MatterPermission resources
      # cease to exist.
    "role": "A String", # The user's role in this matter.
    "accountId": "A String", # The account id, as provided by <a
        # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
  }

close(matterId=*, body=None, x__xgafv=None)

Closes the specified matter. Returns matter with updated state.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Close a matter by ID.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to a CloseMatterRequest.
    "matter": { # Represents a matter. # The updated matter, with state CLOSED.
      "matterId": "A String", # The matter ID which is generated by the server.
          # Should be blank when creating a new matter.
      "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
          # defined limit on the number of permissions a matter can have.
        { # Currently each matter only has one owner, and all others are collaborators.
            # When an account is purged, its corresponding MatterPermission resources
            # cease to exist.
          "role": "A String", # The user's role in this matter.
          "accountId": "A String", # The account id, as provided by <a
              # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
        },
      ],
      "state": "A String", # The state of the matter.
      "name": "A String", # The name of the matter.
      "description": "A String", # The description of the matter.
    },
  }

create(body=None, x__xgafv=None)

Creates a new matter with the given name and description. The initial state
is open, and the owner is the method caller. Returns the created matter
with default view.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Represents a matter.
  "matterId": "A String", # The matter ID which is generated by the server.
      # Should be blank when creating a new matter.
  "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
      # defined limit on the number of permissions a matter can have.
    { # Currently each matter only has one owner, and all others are collaborators.
        # When an account is purged, its corresponding MatterPermission resources
        # cease to exist.
      "role": "A String", # The user's role in this matter.
      "accountId": "A String", # The account id, as provided by <a
          # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
    },
  ],
  "state": "A String", # The state of the matter.
  "name": "A String", # The name of the matter.
  "description": "A String", # The description of the matter.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a matter.
    "matterId": "A String", # The matter ID which is generated by the server.
        # Should be blank when creating a new matter.
    "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
        # defined limit on the number of permissions a matter can have.
      { # Currently each matter only has one owner, and all others are collaborators.
          # When an account is purged, its corresponding MatterPermission resources
          # cease to exist.
        "role": "A String", # The user's role in this matter.
        "accountId": "A String", # The account id, as provided by <a
            # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
      },
    ],
    "state": "A String", # The state of the matter.
    "name": "A String", # The name of the matter.
    "description": "A String", # The description of the matter.
  }

delete(matterId=*, x__xgafv=None)

Deletes the specified matter. Returns matter with updated state.

Args:
  matterId: string, The matter ID (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a matter.
    "matterId": "A String", # The matter ID which is generated by the server.
        # Should be blank when creating a new matter.
    "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
        # defined limit on the number of permissions a matter can have.
      { # Currently each matter only has one owner, and all others are collaborators.
          # When an account is purged, its corresponding MatterPermission resources
          # cease to exist.
        "role": "A String", # The user's role in this matter.
        "accountId": "A String", # The account id, as provided by <a
            # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
      },
    ],
    "state": "A String", # The state of the matter.
    "name": "A String", # The name of the matter.
    "description": "A String", # The description of the matter.
  }

get(matterId=*, x__xgafv=None, view=None)

Gets the specified matter.

Args:
  matterId: string, The matter ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  view: string, Specifies which parts of the Matter to return in the response.

Returns:
  An object of the form:

    { # Represents a matter.
    "matterId": "A String", # The matter ID which is generated by the server.
        # Should be blank when creating a new matter.
    "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
        # defined limit on the number of permissions a matter can have.
      { # Currently each matter only has one owner, and all others are collaborators.
          # When an account is purged, its corresponding MatterPermission resources
          # cease to exist.
        "role": "A String", # The user's role in this matter.
        "accountId": "A String", # The account id, as provided by <a
            # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
      },
    ],
    "state": "A String", # The state of the matter.
    "name": "A String", # The name of the matter.
    "description": "A String", # The description of the matter.
  }

list(pageSize=None, state=None, pageToken=None, x__xgafv=None, view=None)

Lists matters the user has access to.

Args:
  pageSize: integer, The number of matters to return in the response.
Default and maximum are 100.
  state: string, If set, list only matters with that specific state. The default is listing
matters of all states.
  pageToken: string, The pagination token as returned in the response.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  view: string, Specifies which parts of the matter to return in response.

Returns:
  An object of the form:

    { # Provides the list of matters.
    "nextPageToken": "A String", # Page token to retrieve the next page of results in the list.
    "matters": [ # List of matters.
      { # Represents a matter.
        "matterId": "A String", # The matter ID which is generated by the server.
            # Should be blank when creating a new matter.
        "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
            # defined limit on the number of permissions a matter can have.
          { # Currently each matter only has one owner, and all others are collaborators.
              # When an account is purged, its corresponding MatterPermission resources
              # cease to exist.
            "role": "A String", # The user's role in this matter.
            "accountId": "A String", # The account id, as provided by <a
                # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
          },
        ],
        "state": "A String", # The state of the matter.
        "name": "A String", # The name of the matter.
        "description": "A String", # The description of the matter.
      },
    ],
  }

list_next(previous_request=*, previous_response=*)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

removePermissions(matterId=*, body=None, x__xgafv=None)

Removes an account as a matter collaborator.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Remove an account as a matter collaborator.
    "accountId": "A String", # The account ID.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }

reopen(matterId=*, body=None, x__xgafv=None)

Reopens the specified matter. Returns matter with updated state.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Reopen a matter by ID.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response to a ReopenMatterRequest.
    "matter": { # Represents a matter. # The updated matter, with state OPEN.
      "matterId": "A String", # The matter ID which is generated by the server.
          # Should be blank when creating a new matter.
      "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
          # defined limit on the number of permissions a matter can have.
        { # Currently each matter only has one owner, and all others are collaborators.
            # When an account is purged, its corresponding MatterPermission resources
            # cease to exist.
          "role": "A String", # The user's role in this matter.
          "accountId": "A String", # The account id, as provided by <a
              # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
        },
      ],
      "state": "A String", # The state of the matter.
      "name": "A String", # The name of the matter.
      "description": "A String", # The description of the matter.
    },
  }

undelete(matterId=*, body=None, x__xgafv=None)

Undeletes the specified matter. Returns matter with updated state.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Undelete a matter by ID.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a matter.
    "matterId": "A String", # The matter ID which is generated by the server.
        # Should be blank when creating a new matter.
    "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
        # defined limit on the number of permissions a matter can have.
      { # Currently each matter only has one owner, and all others are collaborators.
          # When an account is purged, its corresponding MatterPermission resources
          # cease to exist.
        "role": "A String", # The user's role in this matter.
        "accountId": "A String", # The account id, as provided by <a
            # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
      },
    ],
    "state": "A String", # The state of the matter.
    "name": "A String", # The name of the matter.
    "description": "A String", # The description of the matter.
  }

update(matterId=*, body=None, x__xgafv=None)

Updates the specified matter.
This updates only the name and description of the matter, identified by
matter id. Changes to any other fields are ignored.
Returns the default view of the matter.

Args:
  matterId: string, The matter ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a matter.
  "matterId": "A String", # The matter ID which is generated by the server.
      # Should be blank when creating a new matter.
  "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
      # defined limit on the number of permissions a matter can have.
    { # Currently each matter only has one owner, and all others are collaborators.
        # When an account is purged, its corresponding MatterPermission resources
        # cease to exist.
      "role": "A String", # The user's role in this matter.
      "accountId": "A String", # The account id, as provided by <a
          # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
    },
  ],
  "state": "A String", # The state of the matter.
  "name": "A String", # The name of the matter.
  "description": "A String", # The description of the matter.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a matter.
    "matterId": "A String", # The matter ID which is generated by the server.
        # Should be blank when creating a new matter.
    "matterPermissions": [ # List of users and access to the matter. Currently there is no programmer
        # defined limit on the number of permissions a matter can have.
      { # Currently each matter only has one owner, and all others are collaborators.
          # When an account is purged, its corresponding MatterPermission resources
          # cease to exist.
        "role": "A String", # The user's role in this matter.
        "accountId": "A String", # The account id, as provided by <a
            # href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
      },
    ],
    "state": "A String", # The state of the matter.
    "name": "A String", # The name of the matter.
    "description": "A String", # The description of the matter.
  }

G Suite Vault API . matters

Instance Methods

Method Details