catocli 2.1.1__py3-none-any.whl → 2.1.3__py3-none-any.whl

catocli/parsers/query_site_secondaryAwsVSocket/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.site.secondaryAwsVSocket:
-[Click here](https://api.catonetworks.com/documentation/#query-secondaryAwsVSocket) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.site.secondaryAwsVSocket) for documentation on this operation.
 
 ### Usage for query.site.secondaryAwsVSocket:
 
@@ -8,10 +8,12 @@
 
 `catocli query site secondaryAwsVSocket <json>`
 
-`catocli query site secondaryAwsVSocket "$(cat < secondaryAwsVSocket.json)"`
+`catocli query site secondaryAwsVSocket "$(cat < query.site.secondaryAwsVSocket.json)"`
+
+`catocli query site secondaryAwsVSocket '{"socketId":"id"}'`
 
-`catocli query site secondaryAwsVSocket '{"socketId": "ID"}'`
 
 #### Operation Arguments for query.site.secondaryAwsVSocket ####
-`accountId` [ID] - (required) N/A 
-`socketId` [ID] - (required) N/A 
+
+`accountId` [ID] - (required) N/A    
+`socketId` [ID] - (required) N/A    

catocli/parsers/query_site_secondaryAzureVSocket/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.site.secondaryAzureVSocket:
-[Click here](https://api.catonetworks.com/documentation/#query-secondaryAzureVSocket) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.site.secondaryAzureVSocket) for documentation on this operation.
 
 ### Usage for query.site.secondaryAzureVSocket:
 
@@ -8,10 +8,12 @@
 
 `catocli query site secondaryAzureVSocket <json>`
 
-`catocli query site secondaryAzureVSocket "$(cat < secondaryAzureVSocket.json)"`
+`catocli query site secondaryAzureVSocket "$(cat < query.site.secondaryAzureVSocket.json)"`
+
+`catocli query site secondaryAzureVSocket '{"socketId":"id"}'`
 
-`catocli query site secondaryAzureVSocket '{"socketId": "ID"}'`
 
 #### Operation Arguments for query.site.secondaryAzureVSocket ####
-`accountId` [ID] - (required) N/A 
-`socketId` [ID] - (required) N/A 
+
+`accountId` [ID] - (required) N/A    
+`socketId` [ID] - (required) N/A    

catocli/parsers/query_site_siteBgpStatus/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.site.siteBgpStatus:
-[Click here](https://api.catonetworks.com/documentation/#query-siteBgpStatus) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.site.siteBgpStatus) for documentation on this operation.
 
 ### Usage for query.site.siteBgpStatus:
 
@@ -8,10 +8,12 @@
 
 `catocli query site siteBgpStatus <json>`
 
-`catocli query site siteBgpStatus "$(cat < siteBgpStatus.json)"`
+`catocli query site siteBgpStatus "$(cat < query.site.siteBgpStatus.json)"`
+
+`catocli query site siteBgpStatus '{"siteBgpStatusInput":{"siteRefInput":{"by":"ID","input":"string"}}}'`
 
-`catocli query site siteBgpStatus '{"siteBgpStatusInput": {"siteRefInput": {"by": {"by": "enum(ObjectRefBy)"}, "input": {"input": "String"}}}}'`
 
 #### Operation Arguments for query.site.siteBgpStatus ####
-`accountId` [ID] - (required) N/A 
-`siteBgpStatusInput` [SiteBgpStatusInput] - (required) N/A 
+
+`accountId` [ID] - (required) N/A    
+`siteBgpStatusInput` [SiteBgpStatusInput] - (required) N/A    

catocli/parsers/query_socketPortMetrics/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.socketPortMetrics:
-[Click here](https://api.catonetworks.com/documentation/#query-socketPortMetrics) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.socketPortMetrics) for documentation on this operation.
 
 ### Usage for query.socketPortMetrics:
 
@@ -8,16 +8,18 @@
 
 `catocli query socketPortMetrics <json>`
 
-`catocli query socketPortMetrics "$(cat < socketPortMetrics.json)"`
+`catocli query socketPortMetrics "$(cat < query.socketPortMetrics.json)"`
+
+`catocli query socketPortMetrics '{"from":1,"limit":1,"socketPortMetricsDimension":{"fieldName":"account_id"},"socketPortMetricsFilter":{"fieldName":"account_id","operator":"is","values":["string1","string2"]},"socketPortMetricsMeasure":{"aggType":"sum","fieldName":"account_id","trend":true},"socketPortMetricsSort":{"fieldName":"account_id","order":"asc"},"timeFrame":"example_value"}'`
 
-`catocli query socketPortMetrics '{"from": "Int", "limit": "Int", "socketPortMetricsDimension": {"fieldName": {"fieldName": "enum(SocketPortMetricsFieldName)"}}, "socketPortMetricsFilter": {"fieldName": {"fieldName": "enum(SocketPortMetricsFieldName)"}, "operator": {"operator": "enum(FilterOperator)"}, "values": {"values": ["String"]}}, "socketPortMetricsMeasure": {"aggType": {"aggType": "enum(AggregationType)"}, "fieldName": {"fieldName": "enum(SocketPortMetricsFieldName)"}, "trend": {"trend": "Boolean"}}, "socketPortMetricsSort": {"fieldName": {"fieldName": "enum(SocketPortMetricsFieldName)"}, "order": {"order": "enum(DirectionEnum)"}}, "timeFrame": "TimeFrame"}'`
 
 #### Operation Arguments for query.socketPortMetrics ####
-`accountID` [ID] - (required) Account ID 
-`from` [Int] - (optional) N/A 
-`limit` [Int] - (optional) N/A 
-`socketPortMetricsDimension` [SocketPortMetricsDimension[]] - (optional) N/A 
-`socketPortMetricsFilter` [SocketPortMetricsFilter[]] - (optional) N/A 
-`socketPortMetricsMeasure` [SocketPortMetricsMeasure[]] - (optional) N/A 
-`socketPortMetricsSort` [SocketPortMetricsSort[]] - (optional) N/A 
-`timeFrame` [TimeFrame] - (required) N/A 
+
+`accountID` [ID] - (required) Account ID    
+`from` [Int] - (required) N/A    
+`limit` [Int] - (required) N/A    
+`socketPortMetricsDimension` [SocketPortMetricsDimension[]] - (required) N/A    
+`socketPortMetricsFilter` [SocketPortMetricsFilter[]] - (required) N/A    
+`socketPortMetricsMeasure` [SocketPortMetricsMeasure[]] - (required) N/A    
+`socketPortMetricsSort` [SocketPortMetricsSort[]] - (required) N/A    
+`timeFrame` [TimeFrame] - (required) N/A    

catocli/parsers/query_socketPortMetrics/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_socketPortMetrics_parse(query_subparsers):
-	query_socketPortMetrics_parser = query_subparsers.add_parser('socketPortMetrics', 
-			help='socketPortMetrics() query operation', 
-			usage=get_help("query_socketPortMetrics"))
+    query_socketPortMetrics_parser = query_subparsers.add_parser('socketPortMetrics', 
+            help='socketPortMetrics() query operation', 
+            usage=get_help("query_socketPortMetrics"))
 
-	query_socketPortMetrics_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_socketPortMetrics_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_socketPortMetrics_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_socketPortMetrics_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_socketPortMetrics_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_socketPortMetrics_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_socketPortMetrics_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
-	query_socketPortMetrics_parser.set_defaults(func=createRequest,operation_name='query.socketPortMetrics')
+    query_socketPortMetrics_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_socketPortMetrics_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_socketPortMetrics_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_socketPortMetrics_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_socketPortMetrics_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_socketPortMetrics_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_socketPortMetrics_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+    query_socketPortMetrics_parser.set_defaults(func=createRequest,operation_name='query.socketPortMetrics')

catocli/parsers/query_socketPortMetricsTimeSeries/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.socketPortMetricsTimeSeries:
-[Click here](https://api.catonetworks.com/documentation/#query-socketPortMetricsTimeSeries) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.socketPortMetricsTimeSeries) for documentation on this operation.
 
 ### Usage for query.socketPortMetricsTimeSeries:
 
@@ -8,17 +8,19 @@
 
 `catocli query socketPortMetricsTimeSeries <json>`
 
-`catocli query socketPortMetricsTimeSeries "$(cat < socketPortMetricsTimeSeries.json)"`
+`catocli query socketPortMetricsTimeSeries "$(cat < query.socketPortMetricsTimeSeries.json)"`
+
+`catocli query socketPortMetricsTimeSeries '{"buckets":1,"perSecond":true,"socketPortMetricsDimension":{"fieldName":"account_id"},"socketPortMetricsFilter":{"fieldName":"account_id","operator":"is","values":["string1","string2"]},"socketPortMetricsMeasure":{"aggType":"sum","fieldName":"account_id","trend":true},"timeFrame":"example_value","useDefaultSizeBucket":true,"withMissingData":true}'`
 
-`catocli query socketPortMetricsTimeSeries '{"buckets": "Int", "perSecond": "Boolean", "socketPortMetricsDimension": {"fieldName": {"fieldName": "enum(SocketPortMetricsFieldName)"}}, "socketPortMetricsFilter": {"fieldName": {"fieldName": "enum(SocketPortMetricsFieldName)"}, "operator": {"operator": "enum(FilterOperator)"}, "values": {"values": ["String"]}}, "socketPortMetricsMeasure": {"aggType": {"aggType": "enum(AggregationType)"}, "fieldName": {"fieldName": "enum(SocketPortMetricsFieldName)"}, "trend": {"trend": "Boolean"}}, "timeFrame": "TimeFrame", "useDefaultSizeBucket": "Boolean", "withMissingData": "Boolean"}'`
 
 #### Operation Arguments for query.socketPortMetricsTimeSeries ####
-`accountID` [ID] - (required) Account ID 
-`buckets` [Int] - (required) N/A 
-`perSecond` [Boolean] - (optional) whether to normalize the data into per second (i.e. divide by granularity) 
-`socketPortMetricsDimension` [SocketPortMetricsDimension[]] - (optional) N/A 
-`socketPortMetricsFilter` [SocketPortMetricsFilter[]] - (optional) N/A 
-`socketPortMetricsMeasure` [SocketPortMetricsMeasure[]] - (optional) N/A 
-`timeFrame` [TimeFrame] - (required) N/A 
-`useDefaultSizeBucket` [Boolean] - (optional) In case we want to have the default size bucket (from properties) 
-`withMissingData` [Boolean] - (optional) If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1 
+
+`accountID` [ID] - (required) Account ID    
+`buckets` [Int] - (required) N/A    
+`perSecond` [Boolean] - (required) whether to normalize the data into per second (i.e. divide by granularity)    
+`socketPortMetricsDimension` [SocketPortMetricsDimension[]] - (required) N/A    
+`socketPortMetricsFilter` [SocketPortMetricsFilter[]] - (required) N/A    
+`socketPortMetricsMeasure` [SocketPortMetricsMeasure[]] - (required) N/A    
+`timeFrame` [TimeFrame] - (required) N/A    
+`useDefaultSizeBucket` [Boolean] - (required) In case we want to have the default size bucket (from properties)    
+`withMissingData` [Boolean] - (required) If false, the data field will be set to '0' for buckets with no reported data. Otherwise it will be set to -1    

catocli/parsers/query_socketPortMetricsTimeSeries/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_socketPortMetricsTimeSeries_parse(query_subparsers):
-	query_socketPortMetricsTimeSeries_parser = query_subparsers.add_parser('socketPortMetricsTimeSeries', 
-			help='socketPortMetricsTimeSeries() query operation', 
-			usage=get_help("query_socketPortMetricsTimeSeries"))
+    query_socketPortMetricsTimeSeries_parser = query_subparsers.add_parser('socketPortMetricsTimeSeries', 
+            help='socketPortMetricsTimeSeries() query operation', 
+            usage=get_help("query_socketPortMetricsTimeSeries"))
 
-	query_socketPortMetricsTimeSeries_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_socketPortMetricsTimeSeries_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_socketPortMetricsTimeSeries_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_socketPortMetricsTimeSeries_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_socketPortMetricsTimeSeries_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_socketPortMetricsTimeSeries_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_socketPortMetricsTimeSeries_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
-	query_socketPortMetricsTimeSeries_parser.set_defaults(func=createRequest,operation_name='query.socketPortMetricsTimeSeries')
+    query_socketPortMetricsTimeSeries_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_socketPortMetricsTimeSeries_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_socketPortMetricsTimeSeries_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_socketPortMetricsTimeSeries_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_socketPortMetricsTimeSeries_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_socketPortMetricsTimeSeries_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_socketPortMetricsTimeSeries_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+    query_socketPortMetricsTimeSeries_parser.set_defaults(func=createRequest,operation_name='query.socketPortMetricsTimeSeries')

catocli/parsers/query_subDomains/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.subDomains:
-[Click here](https://api.catonetworks.com/documentation/#query-subDomains) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.subDomains) for documentation on this operation.
 
 ### Usage for query.subDomains:
 
@@ -8,10 +8,12 @@
 
 `catocli query subDomains <json>`
 
-`catocli query subDomains "$(cat < subDomains.json)"`
+`catocli query subDomains "$(cat < query.subDomains.json)"`
+
+`catocli query subDomains '{"managedAccount":true}'`
 
-`catocli query subDomains '{"managedAccount": "Boolean"}'`
 
 #### Operation Arguments for query.subDomains ####
-`accountID` [ID] - (required) Unique Identifier of Account 
-`managedAccount` [Boolean] - (optional) When the boolean argument managedAccount is set to true (default), then the query returns all subdomains related to the account 
+
+`accountID` [ID] - (required) Unique Identifier of Account    
+`managedAccount` [Boolean] - (required) When the boolean argument managedAccount is set to true (default), then the query returns all subdomains related to the account    

catocli/parsers/query_subDomains/__init__.py

@@ -1,16 +1,16 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_subDomains_parse(query_subparsers):
-	query_subDomains_parser = query_subparsers.add_parser('subDomains', 
-			help='subDomains() query operation', 
-			usage=get_help("query_subDomains"))
+    query_subDomains_parser = query_subparsers.add_parser('subDomains', 
+            help='subDomains() query operation', 
+            usage=get_help("query_subDomains"))
 
-	query_subDomains_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_subDomains_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_subDomains_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_subDomains_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_subDomains_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_subDomains_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_subDomains_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
-	query_subDomains_parser.set_defaults(func=createRequest,operation_name='query.subDomains')
+    query_subDomains_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_subDomains_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_subDomains_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_subDomains_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_subDomains_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_subDomains_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_subDomains_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+    query_subDomains_parser.set_defaults(func=createRequest,operation_name='query.subDomains')

catocli/parsers/query_xdr/__init__.py

@@ -1,35 +1,35 @@
 
-from ..parserApiClient import createRequest, get_help
+from ..customParserApiClient import createRequest, get_help
 
 def query_xdr_parse(query_subparsers):
-	query_xdr_parser = query_subparsers.add_parser('xdr', 
-			help='xdr() query operation', 
-			usage=get_help("query_xdr"))
+    query_xdr_parser = query_subparsers.add_parser('xdr', 
+            help='xdr() query operation', 
+            usage=get_help("query_xdr"))
 
-	query_xdr_subparsers = query_xdr_parser.add_subparsers()
+    query_xdr_subparsers = query_xdr_parser.add_subparsers()
 
-	query_xdr_stories_parser = query_xdr_subparsers.add_parser('stories', 
-			help='stories() xdr operation', 
-			usage=get_help("query_xdr_stories"))
+    query_xdr_stories_parser = query_xdr_subparsers.add_parser('stories', 
+            help='stories() xdr operation', 
+            usage=get_help("query_xdr_stories"))
 
-	query_xdr_stories_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_xdr_stories_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_xdr_stories_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_xdr_stories_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_xdr_stories_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_xdr_stories_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_xdr_stories_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
-	query_xdr_stories_parser.set_defaults(func=createRequest,operation_name='query.xdr.stories')
+    query_xdr_stories_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_xdr_stories_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_xdr_stories_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_xdr_stories_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_xdr_stories_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_xdr_stories_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_xdr_stories_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+    query_xdr_stories_parser.set_defaults(func=createRequest,operation_name='query.xdr.stories')
 
-	query_xdr_story_parser = query_xdr_subparsers.add_parser('story', 
-			help='story() xdr operation', 
-			usage=get_help("query_xdr_story"))
+    query_xdr_story_parser = query_xdr_subparsers.add_parser('story', 
+            help='story() xdr operation', 
+            usage=get_help("query_xdr_story"))
 
-	query_xdr_story_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
-	query_xdr_story_parser.add_argument('-accountID', help='Override the CATO_ACCOUNT_ID environment variable with this value.')
-	query_xdr_story_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	query_xdr_story_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	query_xdr_story_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	query_xdr_story_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	query_xdr_story_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
-	query_xdr_story_parser.set_defaults(func=createRequest,operation_name='query.xdr.story')
+    query_xdr_story_parser.add_argument('json', nargs='?', default='{}', help='Variables in JSON format (defaults to empty object if not provided).')
+    query_xdr_story_parser.add_argument('-accountID', help='The cato account ID to use for this operation. Overrides the account_id value in the profile setting.  This is use for reseller and MSP accounts to run queries against cato sub accounts from the parent account.')
+    query_xdr_story_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    query_xdr_story_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    query_xdr_story_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    query_xdr_story_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    query_xdr_story_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+    query_xdr_story_parser.set_defaults(func=createRequest,operation_name='query.xdr.story')

catocli/parsers/query_xdr_stories/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.xdr.stories:
-[Click here](https://api.catonetworks.com/documentation/#query-stories) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.xdr.stories) for documentation on this operation.
 
 ### Usage for query.xdr.stories:
 
@@ -8,11 +8,12 @@
 
 `catocli query xdr stories <json>`
 
-`catocli query xdr stories "$(cat < stories.json)"`
+`catocli query xdr stories "$(cat < query.xdr.stories.json)"`
+
+`catocli query xdr stories '{"storyInput":{"pagingInput":{"from":1,"limit":1},"storyFilterInput":{"accountId":{"in":["id1","id2"],"not_in":["id1","id2"]},"criticality":{"eq":1,"gt":1,"gte":1,"in":[1,2],"lt":1,"lte":1,"not_in":[1,2]},"engineType":{"in":"ANOMALY","not_in":"ANOMALY"},"incidentId":{"contains":"string","in":["string1","string2"],"not_in":["string1","string2"]},"ioa":{"contains":"string","in":["string1","string2"],"not_in":["string1","string2"]},"muted":{"is":"string"},"producer":{"in":"AnomalyStats","not_in":"AnomalyStats"},"queryName":{"contains":"string","in":["string1","string2"],"not_in":["string1","string2"]},"severity":{"in":"High","not_in":"High"},"source":{"contains":"string","in":["string1","string2"],"not_in":["string1","string2"]},"sourceIp":{"contains":"string","in":["string1","string2"],"not_in":["string1","string2"]},"status":{"in":"Open","not_in":"Open"},"storyId":{"in":["id1","id2"],"not_in":["id1","id2"]},"timeFrame":{"time":"example_value","timeFrameModifier":"StoryUpdate"},"vendor":{"in":"CATO","not_in":"CATO"},"verdict":{"in":"Suspicious","not_in":"Suspicious"}},"storySortInput":{"fieldName":"firstSignal","order":"asc"}}}'`
 
-`catocli query xdr stories '{"perSecond": "Boolean", "storyInput": {"pagingInput": {"from": {"from": "Int"}, "limit": {"limit": "Int"}}, "storyFilterInput": {"accountId": {"in": {"in": ["ID"]}, "not_in": {"not_in": ["ID"]}}, "criticality": {"eq": {"eq": "Int"}, "gt": {"gt": "Int"}, "gte": {"gte": "Int"}, "in": {"in": ["Int"]}, "lt": {"lt": "Int"}, "lte": {"lte": "Int"}, "not_in": {"not_in": ["Int"]}}, "engineType": {"in": {"in": "enum(StoryEngineTypeEnum)"}, "not_in": {"not_in": "enum(StoryEngineTypeEnum)"}}, "incidentId": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "ioa": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "muted": {"is": {"is": "String"}}, "producer": {"in": {"in": "enum(StoryProducerEnum)"}, "not_in": {"not_in": "enum(StoryProducerEnum)"}}, "queryName": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "severity": {"in": {"in": "enum(SeverityEnum)"}, "not_in": {"not_in": "enum(SeverityEnum)"}}, "source": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "sourceIp": {"contains": {"contains": "String"}, "in": {"in": ["String"]}, "not_in": {"not_in": ["String"]}}, "status": {"in": {"in": "enum(StoryStatusEnum)"}, "not_in": {"not_in": "enum(StoryStatusEnum)"}}, "storyId": {"in": {"in": ["ID"]}, "not_in": {"not_in": ["ID"]}}, "timeFrame": {"time": {"time": "TimeFrame"}, "timeFrameModifier": {"timeFrameModifier": "enum(TimeFrameModifier)"}}, "vendor": {"in": {"in": "enum(VendorEnum)"}, "not_in": {"not_in": "enum(VendorEnum)"}}, "verdict": {"in": {"in": "enum(StoryVerdictEnum)"}, "not_in": {"not_in": "enum(StoryVerdictEnum)"}}}, "storySortInput": {"fieldName": {"fieldName": "enum(StorySortFieldName)"}, "order": {"order": "enum(SortDirectionEnum)"}}}}'`
 
 #### Operation Arguments for query.xdr.stories ####
-`accountID` [ID] - (required) N/A 
-`perSecond` [Boolean] - (optional) whether to normalize the data into per second (i.e. divide by granularity) 
-`storyInput` [StoryInput] - (required) N/A 
+
+`accountID` [ID] - (required) N/A    
+`storyInput` [StoryInput] - (required) N/A    

catocli/parsers/query_xdr_story/README.md

@@ -1,6 +1,6 @@
 
 ## CATO-CLI - query.xdr.story:
-[Click here](https://api.catonetworks.com/documentation/#query-story) for documentation on this operation.
+[Click here](https://api.catonetworks.com/documentation/#query-query.xdr.story) for documentation on this operation.
 
 ### Usage for query.xdr.story:
 
@@ -8,13 +8,14 @@
 
 `catocli query xdr story <json>`
 
-`catocli query xdr story "$(cat < story.json)"`
+`catocli query xdr story "$(cat < query.xdr.story.json)"`
+
+`catocli query xdr story '{"incidentId":"id","producer":"AnomalyStats","storyId":"id"}'`
 
-`catocli query xdr story '{"incidentId": "ID", "perSecond": "Boolean", "producer": "enum(StoryProducerEnum)", "storyId": "ID"}'`
 
 #### Operation Arguments for query.xdr.story ####
-`accountID` [ID] - (required) N/A 
-`incidentId` [ID] - (optional) N/A 
-`perSecond` [Boolean] - (optional) whether to normalize the data into per second (i.e. divide by granularity) 
-`producer` [StoryProducerEnum] - (optional) N/A Default Value: ['AnomalyStats', 'AnomalyEvents', 'AnomalyExperience', 'ThreatHunt', 'ThreatPrevention', 'NetworkMonitor', 'NetworkXDR', 'MicrosoftEndpointDefender', 'CatoEndpointAlert', 'EntraIdAlert']
-`storyId` [ID] - (optional) N/A 
+
+`accountID` [ID] - (required) N/A    
+`incidentId` [ID] - (required) N/A    
+`producer` [StoryProducerEnum] - (required) N/A Default Value: ['AnomalyStats', 'AnomalyEvents', 'AnomalyExperience', 'ThreatHunt', 'ThreatPrevention', 'NetworkMonitor', 'NetworkXDR', 'MicrosoftEndpointDefender', 'CatoEndpointAlert', 'EntraIdAlert']   
+`storyId` [ID] - (required) N/A    

catocli/parsers/raw/__init__.py

@@ -1,12 +1,12 @@
 
-from ..parserApiClient import createRawRequest, get_help
+from ..customParserApiClient import createRawRequest, get_help
 
 def raw_parse(raw_parser):
-	raw_parser.add_argument('json', nargs='?', default='{}', help='Query, Variables and opertaionName in JSON format (defaults to empty object if not provided).')
-	raw_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
-	raw_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
-	raw_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
-	raw_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
-	raw_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
-	raw_parser.add_argument('--endpoint', dest='endpoint', help='Override the API endpoint URL (e.g., https://api.catonetworks.com/api/v1/graphql2)')
-	raw_parser.set_defaults(func=createRawRequest,operation_name='raw')
+    raw_parser.add_argument('json', nargs='?', default='{}', help='Query, Variables and opertaionName in JSON format (defaults to empty object if not provided).')
+    raw_parser.add_argument('-t', const=True, default=False, nargs='?', help='Print GraphQL query without sending API call')
+    raw_parser.add_argument('-v', const=True, default=False, nargs='?', help='Verbose output')
+    raw_parser.add_argument('-p', const=True, default=False, nargs='?', help='Pretty print')
+    raw_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
+    raw_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
+    raw_parser.add_argument('--endpoint', dest='endpoint', help='Override the API endpoint URL (e.g., https://api.catonetworks.com/api/v1/graphql2)')
+    raw_parser.set_defaults(func=createRawRequest,operation_name='raw')

{catocli-2.1.1.dist-info → catocli-2.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: catocli
-Version: 2.1.1
+Version: 2.1.3
 Summary: Cato Networks cli wrapper for the GraphQL API.
 Home-page: https://github.com/Cato-Networks/cato-cli
 Author: Cato Networks