-
Notifications
You must be signed in to change notification settings - Fork 186
/
item_request_builder.py
263 lines (209 loc) · 10.4 KB
/
item_request_builder.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# -*- coding: utf-8 -*-
'''
# Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
#
# This file was generated and any changes will be overwritten.
'''
from __future__ import unicode_literals
from .item_request import ItemRequest
from ..request_builder_base import RequestBuilderBase
from ..request.item_create_session import ItemCreateSessionRequestBuilder
from ..request.item_copy import ItemCopyRequestBuilder
from ..request.item_create_link import ItemCreateLinkRequestBuilder
from ..request.item_invite import ItemInviteRequestBuilder
from ..request.item_delta import ItemDeltaRequestBuilder
from ..request.item_search import ItemSearchRequestBuilder
from ..request.item_content_request import ItemContentRequestBuilder
class ItemRequestBuilder(RequestBuilderBase):
def __init__(self, request_url, client):
"""Initialize the ItemRequestBuilder
Args:
request_url (str): The url to perform the ItemRequest
on
client (:class:`OneDriveClient<onedrivesdk.request.one_drive_client.OneDriveClient>`):
The client which will be used for the request
"""
super(ItemRequestBuilder, self).__init__(request_url, client)
def request(self, expand=None, select=None, options=None):
"""Builds the ItemRequest
Args:
expand (str): Default None, comma-seperated list of relationships
to expand in the response.
select (str): Default None, comma-seperated list of properties to
include in the response.
options (list of :class:`Option<onedrivesdk.options.Option>`):
A list of options to pass into the request. Defaults to None.
Returns:
:class:`ItemRequest<onedrivesdk.request.item_request.ItemRequest>`:
The ItemRequest
"""
req = ItemRequest(self._request_url, self._client, options)
req._set_query_options(expand=expand, select=select)
return req
def delete(self):
"""Deletes the specified Item."""
self.request().delete()
def get(self):
"""Gets the specified Item.
Returns:
:class:`Item<onedrivesdk.model.item.Item>`:
The Item.
"""
return self.request().get()
def update(self, item):
"""Updates the specified Item.
Args:
item (:class:`Item<onedrivesdk.model.item.Item>`):
The Item to update.
Returns:
:class:`Item<onedrivesdk.model.item.Item>`:
The updated Item
"""
return self.request().update(item)
def upload(self, local_path):
"""Uploads the file using PUT
Args:
local_path (str): The path to the local file to upload.
Returns:
The created entity.
"""
return self.content.request().upload(local_path)
def download(self, local_path):
"""Downloads the specified entity.
Args:
local_path (str): The path where the entity should be
downloaded to
"""
return self.content.request().download(local_path)
@property
def permissions(self):
"""The permissions for the ItemRequestBuilder
Returns:
:class:`PermissionsCollectionRequestBuilder<onedrivesdk.request.permissions_collection.PermissionsCollectionRequestBuilder>`:
A request builder created from the ItemRequestBuilder
"""
return PermissionsCollectionRequestBuilder(self.append_to_request_url("permissions"), self._client)
@property
def subscriptions(self):
"""The subscriptions for the ItemRequestBuilder
Returns:
:class:`SubscriptionsCollectionRequestBuilder<onedrivesdk.request.subscriptions_collection.SubscriptionsCollectionRequestBuilder>`:
A request builder created from the ItemRequestBuilder
"""
return SubscriptionsCollectionRequestBuilder(self.append_to_request_url("subscriptions"), self._client)
@property
def versions(self):
"""The versions for the ItemRequestBuilder
Returns:
:class:`VersionsCollectionRequestBuilder<onedrivesdk.request.versions_collection.VersionsCollectionRequestBuilder>`:
A request builder created from the ItemRequestBuilder
"""
return VersionsCollectionRequestBuilder(self.append_to_request_url("versions"), self._client)
@property
def children(self):
"""The children for the ItemRequestBuilder
Returns:
:class:`ChildrenCollectionRequestBuilder<onedrivesdk.request.children_collection.ChildrenCollectionRequestBuilder>`:
A request builder created from the ItemRequestBuilder
"""
return ChildrenCollectionRequestBuilder(self.append_to_request_url("children"), self._client)
@property
def tags(self):
"""The tags for the ItemRequestBuilder
Returns:
:class:`TagsCollectionRequestBuilder<onedrivesdk.request.tags_collection.TagsCollectionRequestBuilder>`:
A request builder created from the ItemRequestBuilder
"""
return TagsCollectionRequestBuilder(self.append_to_request_url("tags"), self._client)
@property
def thumbnails(self):
"""The thumbnails for the ItemRequestBuilder
Returns:
:class:`ThumbnailsCollectionRequestBuilder<onedrivesdk.request.thumbnails_collection.ThumbnailsCollectionRequestBuilder>`:
A request builder created from the ItemRequestBuilder
"""
return ThumbnailsCollectionRequestBuilder(self.append_to_request_url("thumbnails"), self._client)
@property
def content(self):
"""The content for the ItemRequestBuilder
Returns:
:class:`ItemContentRequestBuilder<onedrivesdk.request.item_content.ItemContentRequestBuilder>`:
A request builder created from the ItemRequestBuilder
"""
return ItemContentRequestBuilder(self.append_to_request_url("content"), self._client)
def create_session(self, item=None):
"""Executes the createSession method
Args:
item (:class:`ChunkedUploadSessionDescriptor<onedrivesdk.model.chunked_upload_session_descriptor.ChunkedUploadSessionDescriptor>`):
Defaults to None, The item to use in the method request
Returns:
:class:`ItemCreateSessionRequestBuilder<onedrivesdk.request.item_create_session.ItemCreateSessionRequestBuilder>`:
A ItemCreateSessionRequestBuilder for the method
"""
return ItemCreateSessionRequestBuilder(self.append_to_request_url("upload.createSession"), self._client, item=item)
def copy(self, name=None, parent_reference=None):
"""Executes the copy method
Args:
name (str):
The name to use in the method request
parent_reference (:class:`ItemReference<onedrivesdk.model.item_reference.ItemReference>`):
Defaults to None, The parent_reference to use in the method request
Returns:
:class:`ItemCopyRequestBuilder<onedrivesdk.request.item_copy.ItemCopyRequestBuilder>`:
A ItemCopyRequestBuilder for the method
"""
return ItemCopyRequestBuilder(self.append_to_request_url("action.copy"), self._client, name=name, parent_reference=parent_reference)
def create_link(self, type):
"""Executes the createLink method
Args:
type (str):
The type to use in the method request
Returns:
:class:`ItemCreateLinkRequestBuilder<onedrivesdk.request.item_create_link.ItemCreateLinkRequestBuilder>`:
A ItemCreateLinkRequestBuilder for the method
"""
return ItemCreateLinkRequestBuilder(self.append_to_request_url("action.createLink"), self._client, type)
def invite(self, recipients, require_sign_in=None, roles=None, send_invitation=None, message=None):
"""Executes the invite method
Args:
require_sign_in (bool):
The require_sign_in to use in the method request
roles (str):
The roles to use in the method request
recipients (:class:`Recipients<onedrivesdk.model.recipients.Recipients>`):
The recipients to use in the method request
send_invitation (bool):
The send_invitation to use in the method request
message (str):
The message to use in the method request
Returns:
:class:`ItemInviteRequestBuilder<onedrivesdk.request.item_invite.ItemInviteRequestBuilder>`:
A ItemInviteRequestBuilder for the method
"""
return ItemInviteRequestBuilder(self.append_to_request_url("action.invite"), self._client, recipients, require_sign_in=require_sign_in, roles=roles, send_invitation=send_invitation, message=message)
def delta(self, token=None):
"""Executes the delta method
Args:
token (str):
The token to use in the method request
Returns:
:class:`ItemDeltaRequestBuilder<onedrivesdk.request.item_delta.ItemDeltaRequestBuilder>`:
A ItemDeltaRequestBuilder for the method
"""
return ItemDeltaRequestBuilder(self.append_to_request_url("view.delta"), self._client, token=token)
def search(self, q=None):
"""Executes the search method
Args:
q (str):
The q to use in the method request
Returns:
:class:`ItemSearchRequestBuilder<onedrivesdk.request.item_search.ItemSearchRequestBuilder>`:
A ItemSearchRequestBuilder for the method
"""
return ItemSearchRequestBuilder(self.append_to_request_url("view.search"), self._client, q=q)
from ..request.permissions_collection import PermissionsCollectionRequestBuilder
from ..request.subscriptions_collection import SubscriptionsCollectionRequestBuilder
from ..request.versions_collection import VersionsCollectionRequestBuilder
from ..request.children_collection import ChildrenCollectionRequestBuilder
from ..request.tags_collection import TagsCollectionRequestBuilder
from ..request.thumbnails_collection import ThumbnailsCollectionRequestBuilder