appwrite-cli 11.0.0 → 11.1.1

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.
@@ -43,6 +43,7 @@ const messaging = new Command("messaging").description(commandDescriptions['mess
43
43
  * @typedef {Object} MessagingListMessagesRequestParams
44
44
  * @property {string[]} 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
45
45
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
46
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
46
47
  * @property {boolean} overrideForCli
47
48
  * @property {boolean} parseOutput
48
49
  * @property {libClient | undefined} sdk
@@ -51,7 +52,7 @@ const messaging = new Command("messaging").description(commandDescriptions['mess
51
52
  /**
52
53
  * @param {MessagingListMessagesRequestParams} params
53
54
  */
54
- const messagingListMessages = async ({queries,search,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
55
+ const messagingListMessages = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
55
56
  let client = !sdk ? await sdkForProject() :
56
57
  sdk;
57
58
  let apiPath = '/messaging/messages';
@@ -62,6 +63,9 @@ const messagingListMessages = async ({queries,search,parseOutput = true, overrid
62
63
  if (typeof search !== 'undefined') {
63
64
  payload['search'] = search;
64
65
  }
66
+ if (typeof total !== 'undefined') {
67
+ payload['total'] = total;
68
+ }
65
69
 
66
70
  let response = undefined;
67
71
 
@@ -639,6 +643,7 @@ const messagingDelete = async ({messageId,parseOutput = true, overrideForCli = f
639
643
  * @typedef {Object} MessagingListMessageLogsRequestParams
640
644
  * @property {string} messageId Message ID.
641
645
  * @property {string[]} 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
646
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
642
647
  * @property {boolean} overrideForCli
643
648
  * @property {boolean} parseOutput
644
649
  * @property {libClient | undefined} sdk
@@ -647,7 +652,7 @@ const messagingDelete = async ({messageId,parseOutput = true, overrideForCli = f
647
652
  /**
648
653
  * @param {MessagingListMessageLogsRequestParams} params
649
654
  */
650
- const messagingListMessageLogs = async ({messageId,queries,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
655
+ const messagingListMessageLogs = async ({messageId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
651
656
  let client = !sdk ? await sdkForProject() :
652
657
  sdk;
653
658
  let apiPath = '/messaging/messages/{messageId}/logs'.replace('{messageId}', messageId);
@@ -655,6 +660,9 @@ const messagingListMessageLogs = async ({messageId,queries,parseOutput = true, o
655
660
  if (typeof queries !== 'undefined') {
656
661
  payload['queries'] = queries;
657
662
  }
663
+ if (typeof total !== 'undefined') {
664
+ payload['total'] = total;
665
+ }
658
666
 
659
667
  let response = undefined;
660
668
 
@@ -676,6 +684,7 @@ const messagingListMessageLogs = async ({messageId,queries,parseOutput = true, o
676
684
  * @typedef {Object} MessagingListTargetsRequestParams
677
685
  * @property {string} messageId Message ID.
678
686
  * @property {string[]} 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
687
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
679
688
  * @property {boolean} overrideForCli
680
689
  * @property {boolean} parseOutput
681
690
  * @property {libClient | undefined} sdk
@@ -684,7 +693,7 @@ const messagingListMessageLogs = async ({messageId,queries,parseOutput = true, o
684
693
  /**
685
694
  * @param {MessagingListTargetsRequestParams} params
686
695
  */
687
- const messagingListTargets = async ({messageId,queries,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
696
+ const messagingListTargets = async ({messageId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
688
697
  let client = !sdk ? await sdkForProject() :
689
698
  sdk;
690
699
  let apiPath = '/messaging/messages/{messageId}/targets'.replace('{messageId}', messageId);
@@ -692,6 +701,9 @@ const messagingListTargets = async ({messageId,queries,parseOutput = true, overr
692
701
  if (typeof queries !== 'undefined') {
693
702
  payload['queries'] = queries;
694
703
  }
704
+ if (typeof total !== 'undefined') {
705
+ payload['total'] = total;
706
+ }
695
707
 
696
708
  let response = undefined;
697
709
 
@@ -709,6 +721,7 @@ const messagingListTargets = async ({messageId,queries,parseOutput = true, overr
709
721
  * @typedef {Object} MessagingListProvidersRequestParams
710
722
  * @property {string[]} 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
711
723
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
724
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
712
725
  * @property {boolean} overrideForCli
713
726
  * @property {boolean} parseOutput
714
727
  * @property {libClient | undefined} sdk
@@ -717,7 +730,7 @@ const messagingListTargets = async ({messageId,queries,parseOutput = true, overr
717
730
  /**
718
731
  * @param {MessagingListProvidersRequestParams} params
719
732
  */
720
- const messagingListProviders = async ({queries,search,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
733
+ const messagingListProviders = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
721
734
  let client = !sdk ? await sdkForProject() :
722
735
  sdk;
723
736
  let apiPath = '/messaging/providers';
@@ -728,6 +741,9 @@ const messagingListProviders = async ({queries,search,parseOutput = true, overri
728
741
  if (typeof search !== 'undefined') {
729
742
  payload['search'] = search;
730
743
  }
744
+ if (typeof total !== 'undefined') {
745
+ payload['total'] = total;
746
+ }
731
747
 
732
748
  let response = undefined;
733
749
 
@@ -2073,6 +2089,7 @@ const messagingDeleteProvider = async ({providerId,parseOutput = true, overrideF
2073
2089
  * @typedef {Object} MessagingListProviderLogsRequestParams
2074
2090
  * @property {string} providerId Provider ID.
2075
2091
  * @property {string[]} 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
2092
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
2076
2093
  * @property {boolean} overrideForCli
2077
2094
  * @property {boolean} parseOutput
2078
2095
  * @property {libClient | undefined} sdk
@@ -2081,7 +2098,7 @@ const messagingDeleteProvider = async ({providerId,parseOutput = true, overrideF
2081
2098
  /**
2082
2099
  * @param {MessagingListProviderLogsRequestParams} params
2083
2100
  */
2084
- const messagingListProviderLogs = async ({providerId,queries,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
2101
+ const messagingListProviderLogs = async ({providerId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
2085
2102
  let client = !sdk ? await sdkForProject() :
2086
2103
  sdk;
2087
2104
  let apiPath = '/messaging/providers/{providerId}/logs'.replace('{providerId}', providerId);
@@ -2089,6 +2106,9 @@ const messagingListProviderLogs = async ({providerId,queries,parseOutput = true,
2089
2106
  if (typeof queries !== 'undefined') {
2090
2107
  payload['queries'] = queries;
2091
2108
  }
2109
+ if (typeof total !== 'undefined') {
2110
+ payload['total'] = total;
2111
+ }
2092
2112
 
2093
2113
  let response = undefined;
2094
2114
 
@@ -2106,6 +2126,7 @@ const messagingListProviderLogs = async ({providerId,queries,parseOutput = true,
2106
2126
  * @typedef {Object} MessagingListSubscriberLogsRequestParams
2107
2127
  * @property {string} subscriberId Subscriber ID.
2108
2128
  * @property {string[]} 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
2129
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
2109
2130
  * @property {boolean} overrideForCli
2110
2131
  * @property {boolean} parseOutput
2111
2132
  * @property {libClient | undefined} sdk
@@ -2114,7 +2135,7 @@ const messagingListProviderLogs = async ({providerId,queries,parseOutput = true,
2114
2135
  /**
2115
2136
  * @param {MessagingListSubscriberLogsRequestParams} params
2116
2137
  */
2117
- const messagingListSubscriberLogs = async ({subscriberId,queries,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
2138
+ const messagingListSubscriberLogs = async ({subscriberId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
2118
2139
  let client = !sdk ? await sdkForProject() :
2119
2140
  sdk;
2120
2141
  let apiPath = '/messaging/subscribers/{subscriberId}/logs'.replace('{subscriberId}', subscriberId);
@@ -2122,6 +2143,9 @@ const messagingListSubscriberLogs = async ({subscriberId,queries,parseOutput = t
2122
2143
  if (typeof queries !== 'undefined') {
2123
2144
  payload['queries'] = queries;
2124
2145
  }
2146
+ if (typeof total !== 'undefined') {
2147
+ payload['total'] = total;
2148
+ }
2125
2149
 
2126
2150
  let response = undefined;
2127
2151
 
@@ -2139,6 +2163,7 @@ const messagingListSubscriberLogs = async ({subscriberId,queries,parseOutput = t
2139
2163
  * @typedef {Object} MessagingListTopicsRequestParams
2140
2164
  * @property {string[]} 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
2141
2165
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
2166
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
2142
2167
  * @property {boolean} overrideForCli
2143
2168
  * @property {boolean} parseOutput
2144
2169
  * @property {libClient | undefined} sdk
@@ -2147,7 +2172,7 @@ const messagingListSubscriberLogs = async ({subscriberId,queries,parseOutput = t
2147
2172
  /**
2148
2173
  * @param {MessagingListTopicsRequestParams} params
2149
2174
  */
2150
- const messagingListTopics = async ({queries,search,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
2175
+ const messagingListTopics = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
2151
2176
  let client = !sdk ? await sdkForProject() :
2152
2177
  sdk;
2153
2178
  let apiPath = '/messaging/topics';
@@ -2158,6 +2183,9 @@ const messagingListTopics = async ({queries,search,parseOutput = true, overrideF
2158
2183
  if (typeof search !== 'undefined') {
2159
2184
  payload['search'] = search;
2160
2185
  }
2186
+ if (typeof total !== 'undefined') {
2187
+ payload['total'] = total;
2188
+ }
2161
2189
 
2162
2190
  let response = undefined;
2163
2191
 
@@ -2323,6 +2351,7 @@ const messagingDeleteTopic = async ({topicId,parseOutput = true, overrideForCli
2323
2351
  * @typedef {Object} MessagingListTopicLogsRequestParams
2324
2352
  * @property {string} topicId Topic ID.
2325
2353
  * @property {string[]} 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
2354
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
2326
2355
  * @property {boolean} overrideForCli
2327
2356
  * @property {boolean} parseOutput
2328
2357
  * @property {libClient | undefined} sdk
@@ -2331,7 +2360,7 @@ const messagingDeleteTopic = async ({topicId,parseOutput = true, overrideForCli
2331
2360
  /**
2332
2361
  * @param {MessagingListTopicLogsRequestParams} params
2333
2362
  */
2334
- const messagingListTopicLogs = async ({topicId,queries,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
2363
+ const messagingListTopicLogs = async ({topicId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
2335
2364
  let client = !sdk ? await sdkForProject() :
2336
2365
  sdk;
2337
2366
  let apiPath = '/messaging/topics/{topicId}/logs'.replace('{topicId}', topicId);
@@ -2339,6 +2368,9 @@ const messagingListTopicLogs = async ({topicId,queries,parseOutput = true, overr
2339
2368
  if (typeof queries !== 'undefined') {
2340
2369
  payload['queries'] = queries;
2341
2370
  }
2371
+ if (typeof total !== 'undefined') {
2372
+ payload['total'] = total;
2373
+ }
2342
2374
 
2343
2375
  let response = undefined;
2344
2376
 
@@ -2357,6 +2389,7 @@ const messagingListTopicLogs = async ({topicId,queries,parseOutput = true, overr
2357
2389
  * @property {string} topicId Topic ID. The topic ID subscribed to.
2358
2390
  * @property {string[]} 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
2359
2391
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
2392
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
2360
2393
  * @property {boolean} overrideForCli
2361
2394
  * @property {boolean} parseOutput
2362
2395
  * @property {libClient | undefined} sdk
@@ -2365,7 +2398,7 @@ const messagingListTopicLogs = async ({topicId,queries,parseOutput = true, overr
2365
2398
  /**
2366
2399
  * @param {MessagingListSubscribersRequestParams} params
2367
2400
  */
2368
- const messagingListSubscribers = async ({topicId,queries,search,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
2401
+ const messagingListSubscribers = async ({topicId,queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
2369
2402
  let client = !sdk ? await sdkForProject() :
2370
2403
  sdk;
2371
2404
  let apiPath = '/messaging/topics/{topicId}/subscribers'.replace('{topicId}', topicId);
@@ -2376,6 +2409,9 @@ const messagingListSubscribers = async ({topicId,queries,search,parseOutput = tr
2376
2409
  if (typeof search !== 'undefined') {
2377
2410
  payload['search'] = search;
2378
2411
  }
2412
+ if (typeof total !== 'undefined') {
2413
+ payload['total'] = total;
2414
+ }
2379
2415
 
2380
2416
  let response = undefined;
2381
2417
 
@@ -2497,6 +2533,7 @@ messaging
2497
2533
  .description(`Get a list of all messages from the current Appwrite project.`)
2498
2534
  .option(`--queries [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`)
2499
2535
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
2536
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2500
2537
  .option(`--console`, `Get the resource console url`)
2501
2538
  .action(actionRunner(messagingListMessages))
2502
2539
 
@@ -2624,6 +2661,7 @@ messaging
2624
2661
  .description(`Get the message activity logs listed by its unique ID.`)
2625
2662
  .requiredOption(`--message-id <message-id>`, `Message ID.`)
2626
2663
  .option(`--queries [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`)
2664
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2627
2665
  .option(`--console`, `Get the resource console url`)
2628
2666
  .action(actionRunner(messagingListMessageLogs))
2629
2667
 
@@ -2632,6 +2670,7 @@ messaging
2632
2670
  .description(`Get a list of the targets associated with a message.`)
2633
2671
  .requiredOption(`--message-id <message-id>`, `Message ID.`)
2634
2672
  .option(`--queries [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`)
2673
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2635
2674
  .action(actionRunner(messagingListTargets))
2636
2675
 
2637
2676
  messaging
@@ -2639,6 +2678,7 @@ messaging
2639
2678
  .description(`Get a list of all providers from the current Appwrite project.`)
2640
2679
  .option(`--queries [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`)
2641
2680
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
2681
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2642
2682
  .option(`--console`, `Get the resource console url`)
2643
2683
  .action(actionRunner(messagingListProviders))
2644
2684
 
@@ -2934,6 +2974,7 @@ messaging
2934
2974
  .description(`Get the provider activity logs listed by its unique ID.`)
2935
2975
  .requiredOption(`--provider-id <provider-id>`, `Provider ID.`)
2936
2976
  .option(`--queries [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`)
2977
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2937
2978
  .action(actionRunner(messagingListProviderLogs))
2938
2979
 
2939
2980
  messaging
@@ -2941,6 +2982,7 @@ messaging
2941
2982
  .description(`Get the subscriber activity logs listed by its unique ID.`)
2942
2983
  .requiredOption(`--subscriber-id <subscriber-id>`, `Subscriber ID.`)
2943
2984
  .option(`--queries [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`)
2985
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2944
2986
  .action(actionRunner(messagingListSubscriberLogs))
2945
2987
 
2946
2988
  messaging
@@ -2948,6 +2990,7 @@ messaging
2948
2990
  .description(`Get a list of all topics from the current Appwrite project.`)
2949
2991
  .option(`--queries [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`)
2950
2992
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
2993
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2951
2994
  .option(`--console`, `Get the resource console url`)
2952
2995
  .action(actionRunner(messagingListTopics))
2953
2996
 
@@ -2985,6 +3028,7 @@ messaging
2985
3028
  .description(`Get the topic activity logs listed by its unique ID.`)
2986
3029
  .requiredOption(`--topic-id <topic-id>`, `Topic ID.`)
2987
3030
  .option(`--queries [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`)
3031
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2988
3032
  .action(actionRunner(messagingListTopicLogs))
2989
3033
 
2990
3034
  messaging
@@ -2993,6 +3037,7 @@ messaging
2993
3037
  .requiredOption(`--topic-id <topic-id>`, `Topic ID. The topic ID subscribed to.`)
2994
3038
  .option(`--queries [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`)
2995
3039
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
3040
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2996
3041
  .option(`--console`, `Get the resource console url`)
2997
3042
  .action(actionRunner(messagingListSubscribers))
2998
3043
 
@@ -43,6 +43,7 @@ const migrations = new Command("migrations").description(commandDescriptions['mi
43
43
  * @typedef {Object} MigrationsListRequestParams
44
44
  * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors
45
45
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
46
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
46
47
  * @property {boolean} overrideForCli
47
48
  * @property {boolean} parseOutput
48
49
  * @property {libClient | undefined} sdk
@@ -51,7 +52,7 @@ const migrations = new Command("migrations").description(commandDescriptions['mi
51
52
  /**
52
53
  * @param {MigrationsListRequestParams} params
53
54
  */
54
- const migrationsList = async ({queries,search,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
55
+ const migrationsList = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
55
56
  let client = !sdk ? await sdkForProject() :
56
57
  sdk;
57
58
  let apiPath = '/migrations';
@@ -62,6 +63,9 @@ const migrationsList = async ({queries,search,parseOutput = true, overrideForCli
62
63
  if (typeof search !== 'undefined') {
63
64
  payload['search'] = search;
64
65
  }
66
+ if (typeof total !== 'undefined') {
67
+ payload['total'] = total;
68
+ }
65
69
 
66
70
  let response = undefined;
67
71
 
@@ -685,6 +689,7 @@ migrations
685
689
  .description(`List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.`)
686
690
  .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors`)
687
691
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
692
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
688
693
  .action(actionRunner(migrationsList))
689
694
 
690
695
  migrations
@@ -43,6 +43,7 @@ const projects = new Command("projects").description(commandDescriptions['projec
43
43
  * @typedef {Object} ProjectsListRequestParams
44
44
  * @property {string[]} 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, teamId
45
45
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
46
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
46
47
  * @property {boolean} overrideForCli
47
48
  * @property {boolean} parseOutput
48
49
  * @property {libClient | undefined} sdk
@@ -51,7 +52,7 @@ const projects = new Command("projects").description(commandDescriptions['projec
51
52
  /**
52
53
  * @param {ProjectsListRequestParams} params
53
54
  */
54
- const projectsList = async ({queries,search,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
55
+ const projectsList = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
55
56
  let client = !sdk ? await sdkForConsole() :
56
57
  sdk;
57
58
  let apiPath = '/projects';
@@ -62,6 +63,9 @@ const projectsList = async ({queries,search,parseOutput = true, overrideForCli =
62
63
  if (typeof search !== 'undefined') {
63
64
  payload['search'] = search;
64
65
  }
66
+ if (typeof total !== 'undefined') {
67
+ payload['total'] = total;
68
+ }
65
69
 
66
70
  let response = undefined;
67
71
 
@@ -970,6 +974,7 @@ const projectsCreateJWT = async ({projectId,scopes,duration,parseOutput = true,
970
974
  /**
971
975
  * @typedef {Object} ProjectsListKeysRequestParams
972
976
  * @property {string} projectId Project unique ID.
977
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
973
978
  * @property {boolean} overrideForCli
974
979
  * @property {boolean} parseOutput
975
980
  * @property {libClient | undefined} sdk
@@ -978,11 +983,14 @@ const projectsCreateJWT = async ({projectId,scopes,duration,parseOutput = true,
978
983
  /**
979
984
  * @param {ProjectsListKeysRequestParams} params
980
985
  */
981
- const projectsListKeys = async ({projectId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
986
+ const projectsListKeys = async ({projectId,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
982
987
  let client = !sdk ? await sdkForConsole() :
983
988
  sdk;
984
989
  let apiPath = '/projects/{projectId}/keys'.replace('{projectId}', projectId);
985
990
  let payload = {};
991
+ if (typeof total !== 'undefined') {
992
+ payload['total'] = total;
993
+ }
986
994
 
987
995
  let response = undefined;
988
996
 
@@ -1201,6 +1209,7 @@ const projectsUpdateOAuth2 = async ({projectId,provider,appId,secret,enabled,par
1201
1209
  /**
1202
1210
  * @typedef {Object} ProjectsListPlatformsRequestParams
1203
1211
  * @property {string} projectId Project unique ID.
1212
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
1204
1213
  * @property {boolean} overrideForCli
1205
1214
  * @property {boolean} parseOutput
1206
1215
  * @property {libClient | undefined} sdk
@@ -1209,11 +1218,14 @@ const projectsUpdateOAuth2 = async ({projectId,provider,appId,secret,enabled,par
1209
1218
  /**
1210
1219
  * @param {ProjectsListPlatformsRequestParams} params
1211
1220
  */
1212
- const projectsListPlatforms = async ({projectId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
1221
+ const projectsListPlatforms = async ({projectId,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
1213
1222
  let client = !sdk ? await sdkForConsole() :
1214
1223
  sdk;
1215
1224
  let apiPath = '/projects/{projectId}/platforms'.replace('{projectId}', projectId);
1216
1225
  let payload = {};
1226
+ if (typeof total !== 'undefined') {
1227
+ payload['total'] = total;
1228
+ }
1217
1229
 
1218
1230
  let response = undefined;
1219
1231
 
@@ -1849,6 +1861,7 @@ const projectsDeleteSMSTemplate = async ({projectId,type,locale,parseOutput = tr
1849
1861
  /**
1850
1862
  * @typedef {Object} ProjectsListWebhooksRequestParams
1851
1863
  * @property {string} projectId Project unique ID.
1864
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
1852
1865
  * @property {boolean} overrideForCli
1853
1866
  * @property {boolean} parseOutput
1854
1867
  * @property {libClient | undefined} sdk
@@ -1857,11 +1870,14 @@ const projectsDeleteSMSTemplate = async ({projectId,type,locale,parseOutput = tr
1857
1870
  /**
1858
1871
  * @param {ProjectsListWebhooksRequestParams} params
1859
1872
  */
1860
- const projectsListWebhooks = async ({projectId,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
1873
+ const projectsListWebhooks = async ({projectId,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
1861
1874
  let client = !sdk ? await sdkForConsole() :
1862
1875
  sdk;
1863
1876
  let apiPath = '/projects/{projectId}/webhooks'.replace('{projectId}', projectId);
1864
1877
  let payload = {};
1878
+ if (typeof total !== 'undefined') {
1879
+ payload['total'] = total;
1880
+ }
1865
1881
 
1866
1882
  let response = undefined;
1867
1883
 
@@ -2099,6 +2115,7 @@ projects
2099
2115
  .description(`Get a list of all projects. You can use the query params to filter your results. `)
2100
2116
  .option(`--queries [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, teamId`)
2101
2117
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
2118
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2102
2119
  .option(`--console`, `Get the resource console url`)
2103
2120
  .action(actionRunner(projectsList))
2104
2121
 
@@ -2296,6 +2313,7 @@ projects
2296
2313
  .command(`list-keys`)
2297
2314
  .description(`Get a list of all API keys from the current project. `)
2298
2315
  .requiredOption(`--project-id <project-id>`, `Project unique ID.`)
2316
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2299
2317
  .option(`--console`, `Get the resource console url`)
2300
2318
  .action(actionRunner(projectsListKeys))
2301
2319
 
@@ -2347,6 +2365,7 @@ projects
2347
2365
  .command(`list-platforms`)
2348
2366
  .description(`Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations. `)
2349
2367
  .requiredOption(`--project-id <project-id>`, `Project unique ID.`)
2368
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2350
2369
  .option(`--console`, `Get the resource console url`)
2351
2370
  .action(actionRunner(projectsListPlatforms))
2352
2371
 
@@ -2497,6 +2516,7 @@ projects
2497
2516
  .command(`list-webhooks`)
2498
2517
  .description(`Get a list of all webhooks belonging to the project. You can use the query params to filter your results. `)
2499
2518
  .requiredOption(`--project-id <project-id>`, `Project unique ID.`)
2519
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
2500
2520
  .option(`--console`, `Get the resource console url`)
2501
2521
  .action(actionRunner(projectsListWebhooks))
2502
2522
 
@@ -43,6 +43,7 @@ const proxy = new Command("proxy").description(commandDescriptions['proxy'] ?? '
43
43
  * @typedef {Object} ProxyListRulesRequestParams
44
44
  * @property {string[]} queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch
45
45
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
46
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
46
47
  * @property {boolean} overrideForCli
47
48
  * @property {boolean} parseOutput
48
49
  * @property {libClient | undefined} sdk
@@ -51,7 +52,7 @@ const proxy = new Command("proxy").description(commandDescriptions['proxy'] ?? '
51
52
  /**
52
53
  * @param {ProxyListRulesRequestParams} params
53
54
  */
54
- const proxyListRules = async ({queries,search,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
55
+ const proxyListRules = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
55
56
  let client = !sdk ? await sdkForProject() :
56
57
  sdk;
57
58
  let apiPath = '/proxy/rules';
@@ -62,6 +63,9 @@ const proxyListRules = async ({queries,search,parseOutput = true, overrideForCli
62
63
  if (typeof search !== 'undefined') {
63
64
  payload['search'] = search;
64
65
  }
66
+ if (typeof total !== 'undefined') {
67
+ payload['total'] = total;
68
+ }
65
69
 
66
70
  let response = undefined;
67
71
 
@@ -333,6 +337,7 @@ proxy
333
337
  .description(`Get a list of all the proxy rules. You can use the query params to filter your results.`)
334
338
  .option(`--queries [queries...]`, `Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch`)
335
339
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
340
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
336
341
  .action(actionRunner(proxyListRules))
337
342
 
338
343
  proxy
@@ -43,6 +43,7 @@ const sites = new Command("sites").description(commandDescriptions['sites'] ?? '
43
43
  * @typedef {Object} SitesListRequestParams
44
44
  * @property {string[]} 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
45
45
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
46
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
46
47
  * @property {boolean} overrideForCli
47
48
  * @property {boolean} parseOutput
48
49
  * @property {libClient | undefined} sdk
@@ -51,7 +52,7 @@ const sites = new Command("sites").description(commandDescriptions['sites'] ?? '
51
52
  /**
52
53
  * @param {SitesListRequestParams} params
53
54
  */
54
- const sitesList = async ({queries,search,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
55
+ const sitesList = async ({queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
55
56
  let client = !sdk ? await sdkForProject() :
56
57
  sdk;
57
58
  let apiPath = '/sites';
@@ -62,6 +63,9 @@ const sitesList = async ({queries,search,parseOutput = true, overrideForCli = fa
62
63
  if (typeof search !== 'undefined') {
63
64
  payload['search'] = search;
64
65
  }
66
+ if (typeof total !== 'undefined') {
67
+ payload['total'] = total;
68
+ }
65
69
 
66
70
  let response = undefined;
67
71
 
@@ -561,6 +565,7 @@ const sitesUpdateSiteDeployment = async ({siteId,deploymentId,parseOutput = true
561
565
  * @property {string} siteId Site ID.
562
566
  * @property {string[]} 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
563
567
  * @property {string} search Search term to filter your list results. Max length: 256 chars.
568
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
564
569
  * @property {boolean} overrideForCli
565
570
  * @property {boolean} parseOutput
566
571
  * @property {libClient | undefined} sdk
@@ -569,7 +574,7 @@ const sitesUpdateSiteDeployment = async ({siteId,deploymentId,parseOutput = true
569
574
  /**
570
575
  * @param {SitesListDeploymentsRequestParams} params
571
576
  */
572
- const sitesListDeployments = async ({siteId,queries,search,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
577
+ const sitesListDeployments = async ({siteId,queries,search,total,parseOutput = true, overrideForCli = false, sdk = undefined, console}) => {
573
578
  let client = !sdk ? await sdkForProject() :
574
579
  sdk;
575
580
  let apiPath = '/sites/{siteId}/deployments'.replace('{siteId}', siteId);
@@ -580,6 +585,9 @@ const sitesListDeployments = async ({siteId,queries,search,parseOutput = true, o
580
585
  if (typeof search !== 'undefined') {
581
586
  payload['search'] = search;
582
587
  }
588
+ if (typeof total !== 'undefined') {
589
+ payload['total'] = total;
590
+ }
583
591
 
584
592
  let response = undefined;
585
593
 
@@ -1041,6 +1049,7 @@ const sitesUpdateDeploymentStatus = async ({siteId,deploymentId,parseOutput = tr
1041
1049
  * @typedef {Object} SitesListLogsRequestParams
1042
1050
  * @property {string} siteId Site ID.
1043
1051
  * @property {string[]} 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
1052
+ * @property {boolean} total When set to false, the total count returned will be 0 and will not be calculated.
1044
1053
  * @property {boolean} overrideForCli
1045
1054
  * @property {boolean} parseOutput
1046
1055
  * @property {libClient | undefined} sdk
@@ -1049,7 +1058,7 @@ const sitesUpdateDeploymentStatus = async ({siteId,deploymentId,parseOutput = tr
1049
1058
  /**
1050
1059
  * @param {SitesListLogsRequestParams} params
1051
1060
  */
1052
- const sitesListLogs = async ({siteId,queries,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1061
+ const sitesListLogs = async ({siteId,queries,total,parseOutput = true, overrideForCli = false, sdk = undefined}) => {
1053
1062
  let client = !sdk ? await sdkForProject() :
1054
1063
  sdk;
1055
1064
  let apiPath = '/sites/{siteId}/logs'.replace('{siteId}', siteId);
@@ -1057,6 +1066,9 @@ const sitesListLogs = async ({siteId,queries,parseOutput = true, overrideForCli
1057
1066
  if (typeof queries !== 'undefined') {
1058
1067
  payload['queries'] = queries;
1059
1068
  }
1069
+ if (typeof total !== 'undefined') {
1070
+ payload['total'] = total;
1071
+ }
1060
1072
 
1061
1073
  let response = undefined;
1062
1074
 
@@ -1348,6 +1360,7 @@ sites
1348
1360
  .description(`Get a list of all the project's sites. You can use the query params to filter your results.`)
1349
1361
  .option(`--queries [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`)
1350
1362
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
1363
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1351
1364
  .option(`--console`, `Get the resource console url`)
1352
1365
  .action(actionRunner(sitesList))
1353
1366
 
@@ -1459,12 +1472,13 @@ sites
1459
1472
  .requiredOption(`--site-id <site-id>`, `Site ID.`)
1460
1473
  .option(`--queries [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`)
1461
1474
  .option(`--search <search>`, `Search term to filter your list results. Max length: 256 chars.`)
1475
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1462
1476
  .option(`--console`, `Get the resource console url`)
1463
1477
  .action(actionRunner(sitesListDeployments))
1464
1478
 
1465
1479
  sites
1466
1480
  .command(`create-deployment`)
1467
- .description(`Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the function's deployment to use your new deployment ID.`)
1481
+ .description(`Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.`)
1468
1482
  .requiredOption(`--site-id <site-id>`, `Site ID.`)
1469
1483
  .requiredOption(`--code <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.`)
1470
1484
  .requiredOption(`--activate [value]`, `Automatically activate the deployment when it is finished building.`, (value) => value === undefined ? true : parseBool(value))
@@ -1537,6 +1551,7 @@ sites
1537
1551
  .description(`Get a list of all site logs. You can use the query params to filter your results.`)
1538
1552
  .requiredOption(`--site-id <site-id>`, `Site ID.`)
1539
1553
  .option(`--queries [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`)
1554
+ .option(`--total [value]`, `When set to false, the total count returned will be 0 and will not be calculated.`, (value) => value === undefined ? true : parseBool(value))
1540
1555
  .action(actionRunner(sitesListLogs))
1541
1556
 
1542
1557
  sites