Google Drive API . accessproposals

close()

Close httplib2 connections.

get(fileId, proposalId, x__xgafv=None)

Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).

Args:
  fileId: string, Required. The ID of the item the request is on. (required)
  proposalId: string, Required. The ID of the access proposal to resolve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Manage outstanding access proposals on a file.
  "createTime": "A String", # The creation time.
  "fileId": "A String", # The file ID that the proposal for access is on.
  "proposalId": "A String", # The ID of the access proposal.
  "recipientEmailAddress": "A String", # The email address of the user that will receive permissions, if accepted.
  "requestMessage": "A String", # The message that the requester added to the proposal.
  "requesterEmailAddress": "A String", # The email address of the requesting user.
  "rolesAndViews": [ # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
    { # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
      "role": "A String", # The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`
      "view": "A String", # Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.
    },
  ],
}

list(fileId, pageSize=None, pageToken=None, x__xgafv=None)

List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.

Args:
  fileId: string, Required. The ID of the item the request is on. (required)
  pageSize: integer, Optional. The number of results per page.
  pageToken: string, Optional. The continuation token on the list of access requests.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response to an access proposal list request.
  "accessProposals": [ # The list of access proposals. This field is only populated in Drive API v3.
    { # Manage outstanding access proposals on a file.
      "createTime": "A String", # The creation time.
      "fileId": "A String", # The file ID that the proposal for access is on.
      "proposalId": "A String", # The ID of the access proposal.
      "recipientEmailAddress": "A String", # The email address of the user that will receive permissions, if accepted.
      "requestMessage": "A String", # The message that the requester added to the proposal.
      "requesterEmailAddress": "A String", # The email address of the requesting user.
      "rolesAndViews": [ # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
        { # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
          "role": "A String", # The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`
          "view": "A String", # Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.
        },
      ],
    },
  ],
  "nextPageToken": "A String", # The continuation token for the next page of results. This will be absent if the end of the results list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.
}

list_next()

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.
        

resolve(fileId, proposalId, body=None, x__xgafv=None)

Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).

Args:
  fileId: string, Required. The ID of the item the request is on. (required)
  proposalId: string, Required. The ID of the access proposal to resolve. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for resolving an AccessProposal on a file.
  "action": "A String", # Required. The action to take on the access proposal.
  "role": [ # Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.
    "A String",
  ],
  "sendNotification": True or False, # Optional. Whether to send an email to the requester when the access proposal is denied or accepted.
  "view": "A String", # Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.
}

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