appwrite 19.2.1 → 20.0.0
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.
- checksums.yaml +4 -4
- data/lib/appwrite/client.rb +1 -1
- data/lib/appwrite/enums/build_runtime.rb +2 -0
- data/lib/appwrite/enums/execution_status.rb +1 -0
- data/lib/appwrite/enums/framework.rb +1 -0
- data/lib/appwrite/enums/output.rb +13 -0
- data/lib/appwrite/enums/runtime.rb +2 -0
- data/lib/appwrite/enums/template_reference_type.rb +9 -0
- data/lib/appwrite/enums/theme.rb +8 -0
- data/lib/appwrite/enums/timezone.rb +425 -0
- data/lib/appwrite/enums/{vcs_deployment_type.rb → vcs_reference_type.rb} +1 -1
- data/lib/appwrite/models/bucket.rb +8 -3
- data/lib/appwrite/models/execution.rb +1 -0
- data/lib/appwrite/operator.rb +145 -0
- data/lib/appwrite/query.rb +6 -6
- data/lib/appwrite/services/account.rb +8 -4
- data/lib/appwrite/services/avatars.rb +74 -0
- data/lib/appwrite/services/databases.rb +15 -5
- data/lib/appwrite/services/functions.rb +21 -9
- data/lib/appwrite/services/messaging.rb +117 -9
- data/lib/appwrite/services/sites.rb +22 -10
- data/lib/appwrite/services/storage.rb +13 -5
- data/lib/appwrite/services/tables_db.rb +16 -6
- data/lib/appwrite/services/teams.rb +6 -2
- data/lib/appwrite/services/tokens.rb +3 -1
- data/lib/appwrite/services/users.rb +18 -6
- data/lib/appwrite.rb +16 -1
- metadata +8 -3
|
@@ -11,14 +11,16 @@ module Appwrite
|
|
|
11
11
|
#
|
|
12
12
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType
|
|
13
13
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
14
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
14
15
|
#
|
|
15
16
|
# @return [MessageList]
|
|
16
|
-
def list_messages(queries: nil, search: nil)
|
|
17
|
+
def list_messages(queries: nil, search: nil, total: nil)
|
|
17
18
|
api_path = '/messaging/messages'
|
|
18
19
|
|
|
19
20
|
api_params = {
|
|
20
21
|
queries: queries,
|
|
21
22
|
search: search,
|
|
23
|
+
total: total,
|
|
22
24
|
}
|
|
23
25
|
|
|
24
26
|
api_headers = {
|
|
@@ -430,9 +432,10 @@ module Appwrite
|
|
|
430
432
|
#
|
|
431
433
|
# @param [String] message_id Message ID.
|
|
432
434
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
435
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
433
436
|
#
|
|
434
437
|
# @return [LogList]
|
|
435
|
-
def list_message_logs(message_id:, queries: nil)
|
|
438
|
+
def list_message_logs(message_id:, queries: nil, total: nil)
|
|
436
439
|
api_path = '/messaging/messages/{messageId}/logs'
|
|
437
440
|
.gsub('{messageId}', message_id)
|
|
438
441
|
|
|
@@ -442,6 +445,7 @@ module Appwrite
|
|
|
442
445
|
|
|
443
446
|
api_params = {
|
|
444
447
|
queries: queries,
|
|
448
|
+
total: total,
|
|
445
449
|
}
|
|
446
450
|
|
|
447
451
|
api_headers = {
|
|
@@ -460,9 +464,10 @@ module Appwrite
|
|
|
460
464
|
#
|
|
461
465
|
# @param [String] message_id Message ID.
|
|
462
466
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, providerId, identifier, providerType
|
|
467
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
463
468
|
#
|
|
464
469
|
# @return [TargetList]
|
|
465
|
-
def list_targets(message_id:, queries: nil)
|
|
470
|
+
def list_targets(message_id:, queries: nil, total: nil)
|
|
466
471
|
api_path = '/messaging/messages/{messageId}/targets'
|
|
467
472
|
.gsub('{messageId}', message_id)
|
|
468
473
|
|
|
@@ -472,6 +477,7 @@ module Appwrite
|
|
|
472
477
|
|
|
473
478
|
api_params = {
|
|
474
479
|
queries: queries,
|
|
480
|
+
total: total,
|
|
475
481
|
}
|
|
476
482
|
|
|
477
483
|
api_headers = {
|
|
@@ -490,14 +496,16 @@ module Appwrite
|
|
|
490
496
|
#
|
|
491
497
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled
|
|
492
498
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
499
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
493
500
|
#
|
|
494
501
|
# @return [ProviderList]
|
|
495
|
-
def list_providers(queries: nil, search: nil)
|
|
502
|
+
def list_providers(queries: nil, search: nil, total: nil)
|
|
496
503
|
api_path = '/messaging/providers'
|
|
497
504
|
|
|
498
505
|
api_params = {
|
|
499
506
|
queries: queries,
|
|
500
507
|
search: search,
|
|
508
|
+
total: total,
|
|
501
509
|
}
|
|
502
510
|
|
|
503
511
|
api_headers = {
|
|
@@ -856,6 +864,96 @@ module Appwrite
|
|
|
856
864
|
)
|
|
857
865
|
end
|
|
858
866
|
|
|
867
|
+
# Create a new Resend provider.
|
|
868
|
+
#
|
|
869
|
+
# @param [String] provider_id Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
870
|
+
# @param [String] name Provider name.
|
|
871
|
+
# @param [String] api_key Resend API key.
|
|
872
|
+
# @param [String] from_name Sender Name.
|
|
873
|
+
# @param [String] from_email Sender email address.
|
|
874
|
+
# @param [String] reply_to_name Name set in the reply to field for the mail. Default value is sender name.
|
|
875
|
+
# @param [String] reply_to_email Email set in the reply to field for the mail. Default value is sender email.
|
|
876
|
+
# @param [] enabled Set as enabled.
|
|
877
|
+
#
|
|
878
|
+
# @return [Provider]
|
|
879
|
+
def create_resend_provider(provider_id:, name:, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil, enabled: nil)
|
|
880
|
+
api_path = '/messaging/providers/resend'
|
|
881
|
+
|
|
882
|
+
if provider_id.nil?
|
|
883
|
+
raise Appwrite::Exception.new('Missing required parameter: "providerId"')
|
|
884
|
+
end
|
|
885
|
+
|
|
886
|
+
if name.nil?
|
|
887
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
888
|
+
end
|
|
889
|
+
|
|
890
|
+
api_params = {
|
|
891
|
+
providerId: provider_id,
|
|
892
|
+
name: name,
|
|
893
|
+
apiKey: api_key,
|
|
894
|
+
fromName: from_name,
|
|
895
|
+
fromEmail: from_email,
|
|
896
|
+
replyToName: reply_to_name,
|
|
897
|
+
replyToEmail: reply_to_email,
|
|
898
|
+
enabled: enabled,
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
api_headers = {
|
|
902
|
+
"content-type": 'application/json',
|
|
903
|
+
}
|
|
904
|
+
|
|
905
|
+
@client.call(
|
|
906
|
+
method: 'POST',
|
|
907
|
+
path: api_path,
|
|
908
|
+
headers: api_headers,
|
|
909
|
+
params: api_params,
|
|
910
|
+
response_type: Models::Provider
|
|
911
|
+
)
|
|
912
|
+
end
|
|
913
|
+
|
|
914
|
+
# Update a Resend provider by its unique ID.
|
|
915
|
+
#
|
|
916
|
+
# @param [String] provider_id Provider ID.
|
|
917
|
+
# @param [String] name Provider name.
|
|
918
|
+
# @param [] enabled Set as enabled.
|
|
919
|
+
# @param [String] api_key Resend API key.
|
|
920
|
+
# @param [String] from_name Sender Name.
|
|
921
|
+
# @param [String] from_email Sender email address.
|
|
922
|
+
# @param [String] reply_to_name Name set in the Reply To field for the mail. Default value is Sender Name.
|
|
923
|
+
# @param [String] reply_to_email Email set in the Reply To field for the mail. Default value is Sender Email.
|
|
924
|
+
#
|
|
925
|
+
# @return [Provider]
|
|
926
|
+
def update_resend_provider(provider_id:, name: nil, enabled: nil, api_key: nil, from_name: nil, from_email: nil, reply_to_name: nil, reply_to_email: nil)
|
|
927
|
+
api_path = '/messaging/providers/resend/{providerId}'
|
|
928
|
+
.gsub('{providerId}', provider_id)
|
|
929
|
+
|
|
930
|
+
if provider_id.nil?
|
|
931
|
+
raise Appwrite::Exception.new('Missing required parameter: "providerId"')
|
|
932
|
+
end
|
|
933
|
+
|
|
934
|
+
api_params = {
|
|
935
|
+
name: name,
|
|
936
|
+
enabled: enabled,
|
|
937
|
+
apiKey: api_key,
|
|
938
|
+
fromName: from_name,
|
|
939
|
+
fromEmail: from_email,
|
|
940
|
+
replyToName: reply_to_name,
|
|
941
|
+
replyToEmail: reply_to_email,
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
api_headers = {
|
|
945
|
+
"content-type": 'application/json',
|
|
946
|
+
}
|
|
947
|
+
|
|
948
|
+
@client.call(
|
|
949
|
+
method: 'PATCH',
|
|
950
|
+
path: api_path,
|
|
951
|
+
headers: api_headers,
|
|
952
|
+
params: api_params,
|
|
953
|
+
response_type: Models::Provider
|
|
954
|
+
)
|
|
955
|
+
end
|
|
956
|
+
|
|
859
957
|
# Create a new Sendgrid provider.
|
|
860
958
|
#
|
|
861
959
|
# @param [String] provider_id Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
@@ -1453,9 +1551,10 @@ module Appwrite
|
|
|
1453
1551
|
#
|
|
1454
1552
|
# @param [String] provider_id Provider ID.
|
|
1455
1553
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1554
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
1456
1555
|
#
|
|
1457
1556
|
# @return [LogList]
|
|
1458
|
-
def list_provider_logs(provider_id:, queries: nil)
|
|
1557
|
+
def list_provider_logs(provider_id:, queries: nil, total: nil)
|
|
1459
1558
|
api_path = '/messaging/providers/{providerId}/logs'
|
|
1460
1559
|
.gsub('{providerId}', provider_id)
|
|
1461
1560
|
|
|
@@ -1465,6 +1564,7 @@ module Appwrite
|
|
|
1465
1564
|
|
|
1466
1565
|
api_params = {
|
|
1467
1566
|
queries: queries,
|
|
1567
|
+
total: total,
|
|
1468
1568
|
}
|
|
1469
1569
|
|
|
1470
1570
|
api_headers = {
|
|
@@ -1483,9 +1583,10 @@ module Appwrite
|
|
|
1483
1583
|
#
|
|
1484
1584
|
# @param [String] subscriber_id Subscriber ID.
|
|
1485
1585
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1586
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
1486
1587
|
#
|
|
1487
1588
|
# @return [LogList]
|
|
1488
|
-
def list_subscriber_logs(subscriber_id:, queries: nil)
|
|
1589
|
+
def list_subscriber_logs(subscriber_id:, queries: nil, total: nil)
|
|
1489
1590
|
api_path = '/messaging/subscribers/{subscriberId}/logs'
|
|
1490
1591
|
.gsub('{subscriberId}', subscriber_id)
|
|
1491
1592
|
|
|
@@ -1495,6 +1596,7 @@ module Appwrite
|
|
|
1495
1596
|
|
|
1496
1597
|
api_params = {
|
|
1497
1598
|
queries: queries,
|
|
1599
|
+
total: total,
|
|
1498
1600
|
}
|
|
1499
1601
|
|
|
1500
1602
|
api_headers = {
|
|
@@ -1513,14 +1615,16 @@ module Appwrite
|
|
|
1513
1615
|
#
|
|
1514
1616
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, description, emailTotal, smsTotal, pushTotal
|
|
1515
1617
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
1618
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
1516
1619
|
#
|
|
1517
1620
|
# @return [TopicList]
|
|
1518
|
-
def list_topics(queries: nil, search: nil)
|
|
1621
|
+
def list_topics(queries: nil, search: nil, total: nil)
|
|
1519
1622
|
api_path = '/messaging/topics'
|
|
1520
1623
|
|
|
1521
1624
|
api_params = {
|
|
1522
1625
|
queries: queries,
|
|
1523
1626
|
search: search,
|
|
1627
|
+
total: total,
|
|
1524
1628
|
}
|
|
1525
1629
|
|
|
1526
1630
|
api_headers = {
|
|
@@ -1667,9 +1771,10 @@ module Appwrite
|
|
|
1667
1771
|
#
|
|
1668
1772
|
# @param [String] topic_id Topic ID.
|
|
1669
1773
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
1774
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
1670
1775
|
#
|
|
1671
1776
|
# @return [LogList]
|
|
1672
|
-
def list_topic_logs(topic_id:, queries: nil)
|
|
1777
|
+
def list_topic_logs(topic_id:, queries: nil, total: nil)
|
|
1673
1778
|
api_path = '/messaging/topics/{topicId}/logs'
|
|
1674
1779
|
.gsub('{topicId}', topic_id)
|
|
1675
1780
|
|
|
@@ -1679,6 +1784,7 @@ module Appwrite
|
|
|
1679
1784
|
|
|
1680
1785
|
api_params = {
|
|
1681
1786
|
queries: queries,
|
|
1787
|
+
total: total,
|
|
1682
1788
|
}
|
|
1683
1789
|
|
|
1684
1790
|
api_headers = {
|
|
@@ -1698,9 +1804,10 @@ module Appwrite
|
|
|
1698
1804
|
# @param [String] topic_id Topic ID. The topic ID subscribed to.
|
|
1699
1805
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, provider, type, enabled
|
|
1700
1806
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
1807
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
1701
1808
|
#
|
|
1702
1809
|
# @return [SubscriberList]
|
|
1703
|
-
def list_subscribers(topic_id:, queries: nil, search: nil)
|
|
1810
|
+
def list_subscribers(topic_id:, queries: nil, search: nil, total: nil)
|
|
1704
1811
|
api_path = '/messaging/topics/{topicId}/subscribers'
|
|
1705
1812
|
.gsub('{topicId}', topic_id)
|
|
1706
1813
|
|
|
@@ -1711,6 +1818,7 @@ module Appwrite
|
|
|
1711
1818
|
api_params = {
|
|
1712
1819
|
queries: queries,
|
|
1713
1820
|
search: search,
|
|
1821
|
+
total: total,
|
|
1714
1822
|
}
|
|
1715
1823
|
|
|
1716
1824
|
api_headers = {
|
|
@@ -12,14 +12,16 @@ module Appwrite
|
|
|
12
12
|
#
|
|
13
13
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId
|
|
14
14
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
15
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
15
16
|
#
|
|
16
17
|
# @return [SiteList]
|
|
17
|
-
def list(queries: nil, search: nil)
|
|
18
|
+
def list(queries: nil, search: nil, total: nil)
|
|
18
19
|
api_path = '/sites'
|
|
19
20
|
|
|
20
21
|
api_params = {
|
|
21
22
|
queries: queries,
|
|
22
23
|
search: search,
|
|
24
|
+
total: total,
|
|
23
25
|
}
|
|
24
26
|
|
|
25
27
|
api_headers = {
|
|
@@ -323,9 +325,10 @@ module Appwrite
|
|
|
323
325
|
# @param [String] site_id Site ID.
|
|
324
326
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type
|
|
325
327
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
328
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
326
329
|
#
|
|
327
330
|
# @return [DeploymentList]
|
|
328
|
-
def list_deployments(site_id:, queries: nil, search: nil)
|
|
331
|
+
def list_deployments(site_id:, queries: nil, search: nil, total: nil)
|
|
329
332
|
api_path = '/sites/{siteId}/deployments'
|
|
330
333
|
.gsub('{siteId}', site_id)
|
|
331
334
|
|
|
@@ -336,6 +339,7 @@ module Appwrite
|
|
|
336
339
|
api_params = {
|
|
337
340
|
queries: queries,
|
|
338
341
|
search: search,
|
|
342
|
+
total: total,
|
|
339
343
|
}
|
|
340
344
|
|
|
341
345
|
api_headers = {
|
|
@@ -352,7 +356,7 @@ module Appwrite
|
|
|
352
356
|
|
|
353
357
|
# Create a new site code deployment. Use this endpoint to upload a new
|
|
354
358
|
# version of your site code. To activate your newly uploaded code, you'll
|
|
355
|
-
# need to update the
|
|
359
|
+
# need to update the site's deployment to use your new deployment ID.
|
|
356
360
|
#
|
|
357
361
|
# @param [String] site_id Site ID.
|
|
358
362
|
# @param [file] code Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.
|
|
@@ -453,11 +457,12 @@ module Appwrite
|
|
|
453
457
|
# @param [String] repository Repository name of the template.
|
|
454
458
|
# @param [String] owner The name of the owner of the template.
|
|
455
459
|
# @param [String] root_directory Path to site code in the template repo.
|
|
456
|
-
# @param [
|
|
460
|
+
# @param [TemplateReferenceType] type Type for the reference provided. Can be commit, branch, or tag
|
|
461
|
+
# @param [String] reference Reference value, can be a commit hash, branch name, or release tag
|
|
457
462
|
# @param [] activate Automatically activate the deployment when it is finished building.
|
|
458
463
|
#
|
|
459
464
|
# @return [Deployment]
|
|
460
|
-
def create_template_deployment(site_id:, repository:, owner:, root_directory:,
|
|
465
|
+
def create_template_deployment(site_id:, repository:, owner:, root_directory:, type:, reference:, activate: nil)
|
|
461
466
|
api_path = '/sites/{siteId}/deployments/template'
|
|
462
467
|
.gsub('{siteId}', site_id)
|
|
463
468
|
|
|
@@ -477,15 +482,20 @@ module Appwrite
|
|
|
477
482
|
raise Appwrite::Exception.new('Missing required parameter: "rootDirectory"')
|
|
478
483
|
end
|
|
479
484
|
|
|
480
|
-
if
|
|
481
|
-
raise Appwrite::Exception.new('Missing required parameter: "
|
|
485
|
+
if type.nil?
|
|
486
|
+
raise Appwrite::Exception.new('Missing required parameter: "type"')
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
if reference.nil?
|
|
490
|
+
raise Appwrite::Exception.new('Missing required parameter: "reference"')
|
|
482
491
|
end
|
|
483
492
|
|
|
484
493
|
api_params = {
|
|
485
494
|
repository: repository,
|
|
486
495
|
owner: owner,
|
|
487
496
|
rootDirectory: root_directory,
|
|
488
|
-
|
|
497
|
+
type: type,
|
|
498
|
+
reference: reference,
|
|
489
499
|
activate: activate,
|
|
490
500
|
}
|
|
491
501
|
|
|
@@ -507,7 +517,7 @@ module Appwrite
|
|
|
507
517
|
# This endpoint lets you create deployment from a branch, commit, or a tag.
|
|
508
518
|
#
|
|
509
519
|
# @param [String] site_id Site ID.
|
|
510
|
-
# @param [
|
|
520
|
+
# @param [VCSReferenceType] type Type of reference passed. Allowed values are: branch, commit
|
|
511
521
|
# @param [String] reference VCS reference to create deployment from. Depending on type this can be: branch name, commit hash
|
|
512
522
|
# @param [] activate Automatically activate the deployment when it is finished building.
|
|
513
523
|
#
|
|
@@ -696,9 +706,10 @@ module Appwrite
|
|
|
696
706
|
#
|
|
697
707
|
# @param [String] site_id Site ID.
|
|
698
708
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId
|
|
709
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
699
710
|
#
|
|
700
711
|
# @return [ExecutionList]
|
|
701
|
-
def list_logs(site_id:, queries: nil)
|
|
712
|
+
def list_logs(site_id:, queries: nil, total: nil)
|
|
702
713
|
api_path = '/sites/{siteId}/logs'
|
|
703
714
|
.gsub('{siteId}', site_id)
|
|
704
715
|
|
|
@@ -708,6 +719,7 @@ module Appwrite
|
|
|
708
719
|
|
|
709
720
|
api_params = {
|
|
710
721
|
queries: queries,
|
|
722
|
+
total: total,
|
|
711
723
|
}
|
|
712
724
|
|
|
713
725
|
api_headers = {
|
|
@@ -10,16 +10,18 @@ module Appwrite
|
|
|
10
10
|
# Get a list of all the storage buckets. You can use the query params to
|
|
11
11
|
# filter your results.
|
|
12
12
|
#
|
|
13
|
-
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus
|
|
13
|
+
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations
|
|
14
14
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
15
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
15
16
|
#
|
|
16
17
|
# @return [BucketList]
|
|
17
|
-
def list_buckets(queries: nil, search: nil)
|
|
18
|
+
def list_buckets(queries: nil, search: nil, total: nil)
|
|
18
19
|
api_path = '/storage/buckets'
|
|
19
20
|
|
|
20
21
|
api_params = {
|
|
21
22
|
queries: queries,
|
|
22
23
|
search: search,
|
|
24
|
+
total: total,
|
|
23
25
|
}
|
|
24
26
|
|
|
25
27
|
api_headers = {
|
|
@@ -46,9 +48,10 @@ module Appwrite
|
|
|
46
48
|
# @param [Compression] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
47
49
|
# @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
48
50
|
# @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
51
|
+
# @param [] transformations Are image transformations enabled?
|
|
49
52
|
#
|
|
50
53
|
# @return [Bucket]
|
|
51
|
-
def create_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil)
|
|
54
|
+
def create_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil, transformations: nil)
|
|
52
55
|
api_path = '/storage/buckets'
|
|
53
56
|
|
|
54
57
|
if bucket_id.nil?
|
|
@@ -70,6 +73,7 @@ module Appwrite
|
|
|
70
73
|
compression: compression,
|
|
71
74
|
encryption: encryption,
|
|
72
75
|
antivirus: antivirus,
|
|
76
|
+
transformations: transformations,
|
|
73
77
|
}
|
|
74
78
|
|
|
75
79
|
api_headers = {
|
|
@@ -126,9 +130,10 @@ module Appwrite
|
|
|
126
130
|
# @param [Compression] compression Compression algorithm choosen for compression. Can be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd), For file size above 20MB compression is skipped even if it's enabled
|
|
127
131
|
# @param [] encryption Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled
|
|
128
132
|
# @param [] antivirus Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled
|
|
133
|
+
# @param [] transformations Are image transformations enabled?
|
|
129
134
|
#
|
|
130
135
|
# @return [Bucket]
|
|
131
|
-
def update_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil)
|
|
136
|
+
def update_bucket(bucket_id:, name:, permissions: nil, file_security: nil, enabled: nil, maximum_file_size: nil, allowed_file_extensions: nil, compression: nil, encryption: nil, antivirus: nil, transformations: nil)
|
|
132
137
|
api_path = '/storage/buckets/{bucketId}'
|
|
133
138
|
.gsub('{bucketId}', bucket_id)
|
|
134
139
|
|
|
@@ -150,6 +155,7 @@ module Appwrite
|
|
|
150
155
|
compression: compression,
|
|
151
156
|
encryption: encryption,
|
|
152
157
|
antivirus: antivirus,
|
|
158
|
+
transformations: transformations,
|
|
153
159
|
}
|
|
154
160
|
|
|
155
161
|
api_headers = {
|
|
@@ -199,9 +205,10 @@ module Appwrite
|
|
|
199
205
|
# @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
200
206
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
201
207
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
208
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
202
209
|
#
|
|
203
210
|
# @return [FileList]
|
|
204
|
-
def list_files(bucket_id:, queries: nil, search: nil)
|
|
211
|
+
def list_files(bucket_id:, queries: nil, search: nil, total: nil)
|
|
205
212
|
api_path = '/storage/buckets/{bucketId}/files'
|
|
206
213
|
.gsub('{bucketId}', bucket_id)
|
|
207
214
|
|
|
@@ -212,6 +219,7 @@ module Appwrite
|
|
|
212
219
|
api_params = {
|
|
213
220
|
queries: queries,
|
|
214
221
|
search: search,
|
|
222
|
+
total: total,
|
|
215
223
|
}
|
|
216
224
|
|
|
217
225
|
api_headers = {
|
|
@@ -12,14 +12,16 @@ module Appwrite
|
|
|
12
12
|
#
|
|
13
13
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name
|
|
14
14
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
15
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
15
16
|
#
|
|
16
17
|
# @return [DatabaseList]
|
|
17
|
-
def list(queries: nil, search: nil)
|
|
18
|
+
def list(queries: nil, search: nil, total: nil)
|
|
18
19
|
api_path = '/tablesdb'
|
|
19
20
|
|
|
20
21
|
api_params = {
|
|
21
22
|
queries: queries,
|
|
22
23
|
search: search,
|
|
24
|
+
total: total,
|
|
23
25
|
}
|
|
24
26
|
|
|
25
27
|
api_headers = {
|
|
@@ -342,9 +344,10 @@ module Appwrite
|
|
|
342
344
|
# @param [String] database_id Database ID.
|
|
343
345
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name, enabled, rowSecurity
|
|
344
346
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
347
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
345
348
|
#
|
|
346
349
|
# @return [TableList]
|
|
347
|
-
def list_tables(database_id:, queries: nil, search: nil)
|
|
350
|
+
def list_tables(database_id:, queries: nil, search: nil, total: nil)
|
|
348
351
|
api_path = '/tablesdb/{databaseId}/tables'
|
|
349
352
|
.gsub('{databaseId}', database_id)
|
|
350
353
|
|
|
@@ -355,6 +358,7 @@ module Appwrite
|
|
|
355
358
|
api_params = {
|
|
356
359
|
queries: queries,
|
|
357
360
|
search: search,
|
|
361
|
+
total: total,
|
|
358
362
|
}
|
|
359
363
|
|
|
360
364
|
api_headers = {
|
|
@@ -460,7 +464,7 @@ module Appwrite
|
|
|
460
464
|
# @param [String] table_id Table ID.
|
|
461
465
|
# @param [String] name Table name. Max length: 128 chars.
|
|
462
466
|
# @param [Array] permissions An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
463
|
-
# @param [] row_security Enables configuring permissions for individual rows. A user needs one of row or table
|
|
467
|
+
# @param [] row_security Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
464
468
|
# @param [] enabled Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
|
|
465
469
|
#
|
|
466
470
|
# @return [Table]
|
|
@@ -541,9 +545,10 @@ module Appwrite
|
|
|
541
545
|
# @param [String] database_id Database ID.
|
|
542
546
|
# @param [String] table_id Table ID.
|
|
543
547
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error
|
|
548
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
544
549
|
#
|
|
545
550
|
# @return [ColumnList]
|
|
546
|
-
def list_columns(database_id:, table_id:, queries: nil)
|
|
551
|
+
def list_columns(database_id:, table_id:, queries: nil, total: nil)
|
|
547
552
|
api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns'
|
|
548
553
|
.gsub('{databaseId}', database_id)
|
|
549
554
|
.gsub('{tableId}', table_id)
|
|
@@ -558,6 +563,7 @@ module Appwrite
|
|
|
558
563
|
|
|
559
564
|
api_params = {
|
|
560
565
|
queries: queries,
|
|
566
|
+
total: total,
|
|
561
567
|
}
|
|
562
568
|
|
|
563
569
|
api_headers = {
|
|
@@ -2081,9 +2087,10 @@ module Appwrite
|
|
|
2081
2087
|
# @param [String] database_id Database ID.
|
|
2082
2088
|
# @param [String] table_id Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
2083
2089
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, status, attributes, error
|
|
2090
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
2084
2091
|
#
|
|
2085
2092
|
# @return [ColumnIndexList]
|
|
2086
|
-
def list_indexes(database_id:, table_id:, queries: nil)
|
|
2093
|
+
def list_indexes(database_id:, table_id:, queries: nil, total: nil)
|
|
2087
2094
|
api_path = '/tablesdb/{databaseId}/tables/{tableId}/indexes'
|
|
2088
2095
|
.gsub('{databaseId}', database_id)
|
|
2089
2096
|
.gsub('{tableId}', table_id)
|
|
@@ -2098,6 +2105,7 @@ module Appwrite
|
|
|
2098
2105
|
|
|
2099
2106
|
api_params = {
|
|
2100
2107
|
queries: queries,
|
|
2108
|
+
total: total,
|
|
2101
2109
|
}
|
|
2102
2110
|
|
|
2103
2111
|
api_headers = {
|
|
@@ -2258,9 +2266,10 @@ module Appwrite
|
|
|
2258
2266
|
# @param [String] table_id Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
|
|
2259
2267
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
2260
2268
|
# @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
|
|
2269
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
2261
2270
|
#
|
|
2262
2271
|
# @return [RowList]
|
|
2263
|
-
def list_rows(database_id:, table_id:, queries: nil, transaction_id: nil)
|
|
2272
|
+
def list_rows(database_id:, table_id:, queries: nil, transaction_id: nil, total: nil)
|
|
2264
2273
|
api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows'
|
|
2265
2274
|
.gsub('{databaseId}', database_id)
|
|
2266
2275
|
.gsub('{tableId}', table_id)
|
|
@@ -2276,6 +2285,7 @@ module Appwrite
|
|
|
2276
2285
|
api_params = {
|
|
2277
2286
|
queries: queries,
|
|
2278
2287
|
transactionId: transaction_id,
|
|
2288
|
+
total: total,
|
|
2279
2289
|
}
|
|
2280
2290
|
|
|
2281
2291
|
api_headers = {
|
|
@@ -12,14 +12,16 @@ module Appwrite
|
|
|
12
12
|
#
|
|
13
13
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, total, billingPlan
|
|
14
14
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
15
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
15
16
|
#
|
|
16
17
|
# @return [TeamList]
|
|
17
|
-
def list(queries: nil, search: nil)
|
|
18
|
+
def list(queries: nil, search: nil, total: nil)
|
|
18
19
|
api_path = '/teams'
|
|
19
20
|
|
|
20
21
|
api_params = {
|
|
21
22
|
queries: queries,
|
|
22
23
|
search: search,
|
|
24
|
+
total: total,
|
|
23
25
|
}
|
|
24
26
|
|
|
25
27
|
api_headers = {
|
|
@@ -172,9 +174,10 @@ module Appwrite
|
|
|
172
174
|
# @param [String] team_id Team ID.
|
|
173
175
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles
|
|
174
176
|
# @param [String] search Search term to filter your list results. Max length: 256 chars.
|
|
177
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
175
178
|
#
|
|
176
179
|
# @return [MembershipList]
|
|
177
|
-
def list_memberships(team_id:, queries: nil, search: nil)
|
|
180
|
+
def list_memberships(team_id:, queries: nil, search: nil, total: nil)
|
|
178
181
|
api_path = '/teams/{teamId}/memberships'
|
|
179
182
|
.gsub('{teamId}', team_id)
|
|
180
183
|
|
|
@@ -185,6 +188,7 @@ module Appwrite
|
|
|
185
188
|
api_params = {
|
|
186
189
|
queries: queries,
|
|
187
190
|
search: search,
|
|
191
|
+
total: total,
|
|
188
192
|
}
|
|
189
193
|
|
|
190
194
|
api_headers = {
|
|
@@ -13,9 +13,10 @@ module Appwrite
|
|
|
13
13
|
# @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
14
14
|
# @param [String] file_id File unique ID.
|
|
15
15
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire
|
|
16
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
16
17
|
#
|
|
17
18
|
# @return [ResourceTokenList]
|
|
18
|
-
def list(bucket_id:, file_id:, queries: nil)
|
|
19
|
+
def list(bucket_id:, file_id:, queries: nil, total: nil)
|
|
19
20
|
api_path = '/tokens/buckets/{bucketId}/files/{fileId}'
|
|
20
21
|
.gsub('{bucketId}', bucket_id)
|
|
21
22
|
.gsub('{fileId}', file_id)
|
|
@@ -30,6 +31,7 @@ module Appwrite
|
|
|
30
31
|
|
|
31
32
|
api_params = {
|
|
32
33
|
queries: queries,
|
|
34
|
+
total: total,
|
|
33
35
|
}
|
|
34
36
|
|
|
35
37
|
api_headers = {
|