Class: Appwrite::Projects

Inherits:
Service
  • Object
show all
Defined in:
lib/appwrite/services/projects.rb

Instance Method Summary collapse

Methods inherited from Service

#initialize

Constructor Details

This class inherits a constructor from Appwrite::Service

Instance Method Details

#create_key(project_id:, name:, scopes:) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/appwrite/services/projects.rb', line 95

def create_key(project_id:, name:, scopes:)
    path = '/projects/{projectId}/keys'
        .gsub('{project_id}', project_id)

    params = {
        'name': name, 
        'scopes': scopes
    }

    return @client.call('post', path, {
        'content-type' => 'application/json',
    }, params);
end

#create_platform(project_id:, type:, name:, key: '', store: '', url: '') ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/appwrite/services/projects.rb', line 177

def create_platform(project_id:, type:, name:, key: '', store: '', url: '')
    path = '/projects/{projectId}/platforms'
        .gsub('{project_id}', project_id)

    params = {
        'type': type, 
        'name': name, 
        'key': key, 
        'store': store, 
        'url': url
    }

    return @client.call('post', path, {
        'content-type' => 'application/json',
    }, params);
end

#create_project(name:, team_id:, description: '', logo: '', url: '', legal_name: '', legal_country: '', legal_state: '', legal_city: '', legal_address: '', legal_tax_id: '') ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/appwrite/services/projects.rb', line 15

def create_project(name:, team_id:, description: '', logo: '', url: '', legal_name: '', legal_country: '', legal_state: '', legal_city: '', legal_address: '', legal_tax_id: '')
    path = '/projects'

    params = {
        'name': name, 
        'teamId': team_id, 
        'description': description, 
        'logo': , 
        'url': url, 
        'legalName': legal_name, 
        'legalCountry': legal_country, 
        'legalState': legal_state, 
        'legalCity': legal_city, 
        'legalAddress': legal_address, 
        'legalTaxId': legal_tax_id
    }

    return @client.call('post', path, {
        'content-type' => 'application/json',
    }, params);
end

#create_task(project_id:, name:, status:, schedule:, security:, http_method:, http_url:, http_headers: [], http_user: '', http_pass: '') ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/appwrite/services/projects.rb', line 249

def create_task(project_id:, name:, status:, schedule:, security:, http_method:, http_url:, http_headers: [], http_user: '', http_pass: '')
    path = '/projects/{projectId}/tasks'
        .gsub('{project_id}', project_id)

    params = {
        'name': name, 
        'status': status, 
        'schedule': schedule, 
        'security': security, 
        'httpMethod': http_method, 
        'httpUrl': http_url, 
        'httpHeaders': http_headers, 
        'httpUser': http_user, 
        'httpPass': http_pass
    }

    return @client.call('post', path, {
        'content-type' => 'application/json',
    }, params);
end

#create_webhook(project_id:, name:, events:, url:, security:, http_user: '', http_pass: '') ⇒ Object 



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/appwrite/services/projects.rb', line 342

def create_webhook(project_id:, name:, events:, url:, security:, http_user: '', http_pass: '')
    path = '/projects/{projectId}/webhooks'
        .gsub('{project_id}', project_id)

    params = {
        'name': name, 
        'events': events, 
        'url': url, 
        'security': security, 
        'httpUser': http_user, 
        'httpPass': http_pass
    }

    return @client.call('post', path, {
        'content-type' => 'application/json',
    }, params);
end

#delete_key(project_id:, key_id:) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/appwrite/services/projects.rb', line 137

def delete_key(project_id:, key_id:)
    path = '/projects/{projectId}/keys/{keyId}'
        .gsub('{project_id}', project_id)
        .gsub('{key_id}', key_id)

    params = {
    }

    return @client.call('delete', path, {
        'content-type' => 'application/json',
    }, params);
end

#delete_platform(project_id:, platform_id:) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/appwrite/services/projects.rb', line 224

def delete_platform(project_id:, platform_id:)
    path = '/projects/{projectId}/platforms/{platformId}'
        .gsub('{project_id}', project_id)
        .gsub('{platform_id}', platform_id)

    params = {
    }

    return @client.call('delete', path, {
        'content-type' => 'application/json',
    }, params);
end

#delete_project(project_id:) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/appwrite/services/projects.rb', line 71

def delete_project(project_id:)
    path = '/projects/{projectId}'
        .gsub('{project_id}', project_id)

    params = {
    }

    return @client.call('delete', path, {
        'content-type' => 'application/json',
    }, params);
end

#delete_task(project_id:, task_id:) ⇒ Object 



305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/appwrite/services/projects.rb', line 305

def delete_task(project_id:, task_id:)
    path = '/projects/{projectId}/tasks/{taskId}'
        .gsub('{project_id}', project_id)
        .gsub('{task_id}', task_id)

    params = {
    }

    return @client.call('delete', path, {
        'content-type' => 'application/json',
    }, params);
end

#delete_webhook(project_id:, webhook_id:) ⇒ Object 



392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/appwrite/services/projects.rb', line 392

def delete_webhook(project_id:, webhook_id:)
    path = '/projects/{projectId}/webhooks/{webhookId}'
        .gsub('{project_id}', project_id)
        .gsub('{webhook_id}', webhook_id)

    params = {
    }

    return @client.call('delete', path, {
        'content-type' => 'application/json',
    }, params);
end

#get_key(project_id:, key_id:) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/appwrite/services/projects.rb', line 109

def get_key(project_id:, key_id:)
    path = '/projects/{projectId}/keys/{keyId}'
        .gsub('{project_id}', project_id)
        .gsub('{key_id}', key_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#get_platform(project_id:, platform_id:) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/appwrite/services/projects.rb', line 194

def get_platform(project_id:, platform_id:)
    path = '/projects/{projectId}/platforms/{platformId}'
        .gsub('{project_id}', project_id)
        .gsub('{platform_id}', platform_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#get_project(project_id:) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/appwrite/services/projects.rb', line 37

def get_project(project_id:)
    path = '/projects/{projectId}'
        .gsub('{project_id}', project_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#get_project_usage(project_id:) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/appwrite/services/projects.rb', line 318

def get_project_usage(project_id:)
    path = '/projects/{projectId}/usage'
        .gsub('{project_id}', project_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#get_task(project_id:, task_id:) ⇒ Object 



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/appwrite/services/projects.rb', line 270

def get_task(project_id:, task_id:)
    path = '/projects/{projectId}/tasks/{taskId}'
        .gsub('{project_id}', project_id)
        .gsub('{task_id}', task_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#get_webhook(project_id:, webhook_id:) ⇒ Object 



360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/appwrite/services/projects.rb', line 360

def get_webhook(project_id:, webhook_id:)
    path = '/projects/{projectId}/webhooks/{webhookId}'
        .gsub('{project_id}', project_id)
        .gsub('{webhook_id}', webhook_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#list_keys(project_id:) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/appwrite/services/projects.rb', line 83

def list_keys(project_id:)
    path = '/projects/{projectId}/keys'
        .gsub('{project_id}', project_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#list_platforms(project_id:) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/appwrite/services/projects.rb', line 165

def list_platforms(project_id:)
    path = '/projects/{projectId}/platforms'
        .gsub('{project_id}', project_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#list_projects ⇒ Object 



4
5
6
7
8
9
10
11
12
13
 
# File 'lib/appwrite/services/projects.rb', line 4

def list_projects()
    path = '/projects'

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#list_tasks(project_id:) ⇒ Object 



237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/appwrite/services/projects.rb', line 237

def list_tasks(project_id:)
    path = '/projects/{projectId}/tasks'
        .gsub('{project_id}', project_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#list_webhooks(project_id:) ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/appwrite/services/projects.rb', line 330

def list_webhooks(project_id:)
    path = '/projects/{projectId}/webhooks'
        .gsub('{project_id}', project_id)

    params = {
    }

    return @client.call('get', path, {
        'content-type' => 'application/json',
    }, params);
end

#update_key(project_id:, key_id:, name:, scopes:) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/appwrite/services/projects.rb', line 122

def update_key(project_id:, key_id:, name:, scopes:)
    path = '/projects/{projectId}/keys/{keyId}'
        .gsub('{project_id}', project_id)
        .gsub('{key_id}', key_id)

    params = {
        'name': name, 
        'scopes': scopes
    }

    return @client.call('put', path, {
        'content-type' => 'application/json',
    }, params);
end

#update_platform(project_id:, platform_id:, name:, key: '', store: '', url: '') ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/appwrite/services/projects.rb', line 207

def update_platform(project_id:, platform_id:, name:, key: '', store: '', url: '')
    path = '/projects/{projectId}/platforms/{platformId}'
        .gsub('{project_id}', project_id)
        .gsub('{platform_id}', platform_id)

    params = {
        'name': name, 
        'key': key, 
        'store': store, 
        'url': url
    }

    return @client.call('put', path, {
        'content-type' => 'application/json',
    }, params);
end

#update_project(project_id:, name:, description: '', logo: '', url: '', legal_name: '', legal_country: '', legal_state: '', legal_city: '', legal_address: '', legal_tax_id: '') ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/appwrite/services/projects.rb', line 49

def update_project(project_id:, name:, description: '', logo: '', url: '', legal_name: '', legal_country: '', legal_state: '', legal_city: '', legal_address: '', legal_tax_id: '')
    path = '/projects/{projectId}'
        .gsub('{project_id}', project_id)

    params = {
        'name': name, 
        'description': description, 
        'logo': , 
        'url': url, 
        'legalName': legal_name, 
        'legalCountry': legal_country, 
        'legalState': legal_state, 
        'legalCity': legal_city, 
        'legalAddress': legal_address, 
        'legalTaxId': legal_tax_id
    }

    return @client.call('patch', path, {
        'content-type' => 'application/json',
    }, params);
end

#update_project_o_auth(project_id:, provider:, app_id: '', secret: '') ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/appwrite/services/projects.rb', line 150

def update_project_o_auth(project_id:, provider:, app_id: '', secret: '')
    path = '/projects/{projectId}/oauth'
        .gsub('{project_id}', project_id)

    params = {
        'provider': provider, 
        'appId': app_id, 
        'secret': secret
    }

    return @client.call('patch', path, {
        'content-type' => 'application/json',
    }, params);
end

#update_task(project_id:, task_id:, name:, status:, schedule:, security:, http_method:, http_url:, http_headers: [], http_user: '', http_pass: '') ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/appwrite/services/projects.rb', line 283

def update_task(project_id:, task_id:, name:, status:, schedule:, security:, http_method:, http_url:, http_headers: [], http_user: '', http_pass: '')
    path = '/projects/{projectId}/tasks/{taskId}'
        .gsub('{project_id}', project_id)
        .gsub('{task_id}', task_id)

    params = {
        'name': name, 
        'status': status, 
        'schedule': schedule, 
        'security': security, 
        'httpMethod': http_method, 
        'httpUrl': http_url, 
        'httpHeaders': http_headers, 
        'httpUser': http_user, 
        'httpPass': http_pass
    }

    return @client.call('put', path, {
        'content-type' => 'application/json',
    }, params);
end

#update_webhook(project_id:, webhook_id:, name:, events:, url:, security:, http_user: '', http_pass: '') ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/appwrite/services/projects.rb', line 373

def update_webhook(project_id:, webhook_id:, name:, events:, url:, security:, http_user: '', http_pass: '')
    path = '/projects/{projectId}/webhooks/{webhookId}'
        .gsub('{project_id}', project_id)
        .gsub('{webhook_id}', webhook_id)

    params = {
        'name': name, 
        'events': events, 
        'url': url, 
        'security': security, 
        'httpUser': http_user, 
        'httpPass': http_pass
    }

    return @client.call('put', path, {
        'content-type' => 'application/json',
    }, params);
end