@influxdata/influxdb-client-apis 1.23.0-nightly.1783 → 1.23.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.
package/dist/all.d.ts CHANGED
@@ -3,11 +3,11 @@ import { Headers, InfluxDB, AnnotatedCSVResponse } from '@influxdata/influxdb-cl
3
3
  interface Error {
4
4
  /** code is the machine-readable error code. */
5
5
  readonly code: 'internal error' | 'not found' | 'conflict' | 'invalid' | 'unprocessable entity' | 'empty value' | 'unavailable' | 'forbidden' | 'too many requests' | 'unauthorized' | 'method not allowed' | 'request too large' | 'unsupported media type';
6
- /** message is a human-readable message. */
7
- readonly message: string;
8
- /** op describes the logical code operation during error. Useful for debugging. */
6
+ /** Human-readable message. */
7
+ readonly message?: string;
8
+ /** Describes the logical code operation when the error occurred. Useful for debugging. */
9
9
  readonly op?: string;
10
- /** err is a stack of errors that occurred during processing of the request. Useful for debugging. */
10
+ /** Stack of errors that occurred during processing of the request. Useful for debugging. */
11
11
  readonly err?: string;
12
12
  }
13
13
  interface Routes {
@@ -45,17 +45,17 @@ interface DBRPs {
45
45
  content?: DBRP[];
46
46
  }
47
47
  interface DBRP {
48
- /** the mapping identifier */
48
+ /** ID of the DBRP mapping. */
49
49
  readonly id: string;
50
- /** the organization ID that owns this mapping. */
50
+ /** ID of the organization that owns this mapping. */
51
51
  orgID: string;
52
- /** the bucket ID used as target for the translation. */
52
+ /** ID of the bucket used as the target for the translation. */
53
53
  bucketID: string;
54
54
  /** InfluxDB v1 database */
55
55
  database: string;
56
56
  /** InfluxDB v1 retention policy */
57
57
  retention_policy: string;
58
- /** Specify if this mapping represents the default retention policy for the database specificed. */
58
+ /** Mapping represents the default retention policy for the database specified. */
59
59
  default: boolean;
60
60
  links?: Links;
61
61
  }
@@ -69,17 +69,17 @@ interface Links {
69
69
  */
70
70
  declare type Link = string;
71
71
  interface DBRPCreate {
72
- /** the organization ID that owns this mapping. */
72
+ /** ID of the organization that owns this mapping. */
73
73
  orgID?: string;
74
- /** the organization that owns this mapping. */
74
+ /** Name of the organization that owns this mapping. */
75
75
  org?: string;
76
- /** the bucket ID used as target for the translation. */
76
+ /** ID of the bucket used as the target for the translation. */
77
77
  bucketID: string;
78
78
  /** InfluxDB v1 database */
79
79
  database: string;
80
80
  /** InfluxDB v1 retention policy */
81
81
  retention_policy: string;
82
- /** Specify if this mapping represents the default retention policy for the database specificed. */
82
+ /** Mapping represents the default retention policy for the database specified. */
83
83
  default?: boolean;
84
84
  }
85
85
  interface DBRPGet {
@@ -193,19 +193,19 @@ declare type ResourceOwner = UserResponse & {
193
193
  interface LineProtocolError {
194
194
  /** Code is the machine-readable error code. */
195
195
  readonly code: 'internal error' | 'not found' | 'conflict' | 'invalid' | 'empty value' | 'unavailable';
196
- /** Message is a human-readable message. */
197
- readonly message: string;
198
- /** Op describes the logical code operation during error. Useful for debugging. */
199
- readonly op: string;
200
- /** Err is a stack of errors that occurred during processing of the request. Useful for debugging. */
201
- readonly err: string;
202
- /** First line within sent body containing malformed data */
196
+ /** Human-readable message. */
197
+ readonly message?: string;
198
+ /** Describes the logical code operation when the error occurred. Useful for debugging. */
199
+ readonly op?: string;
200
+ /** Stack of errors that occurred during processing of the request. Useful for debugging. */
201
+ readonly err?: string;
202
+ /** First line in the request body that contains malformed data. */
203
203
  readonly line?: number;
204
204
  }
205
205
  interface LineProtocolLengthError {
206
206
  /** Code is the machine-readable error code. */
207
207
  readonly code: 'invalid';
208
- /** Message is a human-readable message. */
208
+ /** Human-readable message. */
209
209
  readonly message: string;
210
210
  }
211
211
  /**
@@ -374,18 +374,18 @@ interface Axes {
374
374
  y: Axis;
375
375
  }
376
376
  /**
377
- * The description of a particular axis for a visualization.
377
+ * Axis used in a visualization.
378
378
  */
379
379
  interface Axis {
380
- /** The extents of an axis in the form [lower, upper]. Clients determine whether bounds are to be inclusive or exclusive of their limits */
380
+ /** The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. */
381
381
  bounds?: string[];
382
- /** Label is a description of this Axis */
382
+ /** Description of the axis. */
383
383
  label?: string;
384
- /** Prefix represents a label prefix for formatting axis values. */
384
+ /** Label prefix for formatting axis values. */
385
385
  prefix?: string;
386
- /** Suffix represents a label suffix for formatting axis values. */
386
+ /** Label suffix for formatting axis values. */
387
387
  suffix?: string;
388
- /** Base represents the radix for formatting axis values. */
388
+ /** Radix for formatting axis values. */
389
389
  base?: '' | '2' | '10';
390
390
  scale?: AxisScale;
391
391
  }
@@ -609,8 +609,8 @@ interface CheckBase {
609
609
  status?: TaskStatusType;
610
610
  /** An optional description of the check. */
611
611
  description?: string;
612
- /** Timestamp of latest scheduled, completed run, RFC3339. */
613
- readonly latestCompleted?: string;
612
+ /** Timestamp (in RFC3339 date/time format](https://datatracker.ietf.org/doc/html/rfc3339)) of the latest scheduled and completed run. */
613
+ readonly latestCompleted?: any;
614
614
  readonly lastRunStatus?: 'failed' | 'success' | 'canceled';
615
615
  readonly lastRunError?: string;
616
616
  labels?: Labels;
@@ -1313,17 +1313,17 @@ interface Buckets {
1313
1313
  }
1314
1314
  interface Bucket {
1315
1315
  readonly links?: {
1316
- /** URL to retrieve labels for this bucket */
1316
+ /** URL to retrieve labels for this bucket. */
1317
1317
  labels?: Link;
1318
- /** URL to retrieve members that can read this bucket */
1318
+ /** URL to retrieve members that can read this bucket. */
1319
1319
  members?: Link;
1320
- /** URL to retrieve parent organization for this bucket */
1320
+ /** URL to retrieve parent organization for this bucket. */
1321
1321
  org?: Link;
1322
1322
  /** URL to retrieve owners that can read and write to this bucket. */
1323
1323
  owners?: Link;
1324
- /** URL for this bucket */
1324
+ /** URL for this bucket. */
1325
1325
  self?: Link;
1326
- /** URL to write line protocol for this bucket */
1326
+ /** URL to write line protocol to this bucket. */
1327
1327
  write?: Link;
1328
1328
  };
1329
1329
  readonly id?: string;
@@ -1912,31 +1912,35 @@ interface TemplateExportByName {
1912
1912
  }
1913
1913
  interface Task {
1914
1914
  readonly id: string;
1915
- /** The type of task, this can be used for filtering tasks on list actions. */
1915
+ /** Type of the task, useful for filtering a task list. */
1916
1916
  type?: string;
1917
- /** The ID of the organization that owns this Task. */
1917
+ /** ID of the organization that owns the task. */
1918
1918
  orgID: string;
1919
- /** The name of the organization that owns this Task. */
1919
+ /** Name of the organization that owns the task. */
1920
1920
  org?: string;
1921
- /** The name of the task. */
1921
+ /** Name of the task. */
1922
1922
  name: string;
1923
- /** The ID of the user who owns this Task. */
1923
+ /** ID of the user who owns this Task. */
1924
1924
  ownerID?: string;
1925
- /** An optional description of the task. */
1925
+ /** Description of the task. */
1926
1926
  description?: string;
1927
1927
  status?: TaskStatusType;
1928
1928
  labels?: Labels;
1929
- /** The ID of the authorization used when this task communicates with the query engine. */
1929
+ /** ID of the authorization used when the task communicates with the query engine. */
1930
1930
  authorizationID?: string;
1931
- /** The Flux script to run for this task. */
1931
+ /** Flux script to run for this task. */
1932
1932
  flux: string;
1933
- /** A simple task repetition schedule; parsed from Flux. */
1933
+ /** Interval at which the task runs. `every` also determines when the task first runs, depending on the specified time.
1934
+ Value is a [duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals)). */
1934
1935
  every?: string;
1935
- /** A task repetition schedule in the form '* * * * * *'; parsed from Flux. */
1936
+ /** [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. Cron scheduling is based on system time.
1937
+ Value is a [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview). */
1936
1938
  cron?: string;
1937
- /** Duration to delay after the schedule, before executing the task; parsed from flux, if set to zero it will remove this option and use 0 as the default. */
1939
+ /** [Duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset.
1940
+ The value is a [duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals). */
1938
1941
  offset?: string;
1939
- /** Timestamp of latest scheduled, completed run, RFC3339. */
1942
+ /** Timestamp of the latest scheduled and completed run.
1943
+ Value is a timestamp in [RFC3339 date/time format](https://docs.influxdata.com/flux/v0.x/data-types/basic/time/#time-syntax). */
1940
1944
  readonly latestCompleted?: string;
1941
1945
  readonly lastRunStatus?: 'failed' | 'success' | 'canceled';
1942
1946
  readonly lastRunError?: string;
@@ -2037,7 +2041,7 @@ declare type NotificationRuleDiscriminator = (SlackNotificationRule & {
2037
2041
  });
2038
2042
  declare type SlackNotificationRule = NotificationRuleBase & SlackNotificationRuleBase;
2039
2043
  interface NotificationRuleBase {
2040
- /** Timestamp of latest scheduled, completed run, RFC3339. */
2044
+ /** Timestamp (in RFC3339 date/time format](https://datatracker.ietf.org/doc/html/rfc3339)) of the latest scheduled and completed run. */
2041
2045
  readonly latestCompleted?: string;
2042
2046
  readonly lastRunStatus?: 'failed' | 'success' | 'canceled';
2043
2047
  readonly lastRunError?: string;
@@ -2207,18 +2211,18 @@ interface OnboardingResponse {
2207
2211
  declare type Authorization = AuthorizationUpdateRequest & {
2208
2212
  readonly createdAt?: string;
2209
2213
  readonly updatedAt?: string;
2210
- /** ID of org that authorization is scoped to. */
2214
+ /** ID of the organization that the authorization is scoped to. */
2211
2215
  orgID?: string;
2212
- /** List of permissions for an auth. An auth must have at least one Permission. */
2216
+ /** List of permissions for an authorization. An authorization must have at least one permission. */
2213
2217
  permissions?: Permission[];
2214
2218
  readonly id?: string;
2215
- /** Passed via the Authorization Header and Token Authentication type. */
2219
+ /** Token used to authenticate API requests. */
2216
2220
  readonly token?: string;
2217
- /** ID of user that created and owns the token. */
2221
+ /** ID of the user that created and owns the token. */
2218
2222
  readonly userID?: string;
2219
- /** Name of user that created and owns the token. */
2223
+ /** Name of the user that created and owns the token. */
2220
2224
  readonly user?: string;
2221
- /** Name of the org token is scoped to. */
2225
+ /** Name of the organization that the token is scoped to. */
2222
2226
  readonly org?: string;
2223
2227
  readonly links?: {
2224
2228
  readonly self?: Link;
@@ -2226,7 +2230,7 @@ declare type Authorization = AuthorizationUpdateRequest & {
2226
2230
  };
2227
2231
  };
2228
2232
  interface AuthorizationUpdateRequest {
2229
- /** If inactive the token is inactive and requests using the token will be rejected. */
2233
+ /** Status of the token. If `inactive`, requests using the token will be rejected. */
2230
2234
  status?: 'active' | 'inactive';
2231
2235
  /** A description of the token. */
2232
2236
  description?: string;
@@ -2696,7 +2700,7 @@ declare class BackupAPI {
2696
2700
  interface GetBucketsRequest {
2697
2701
  offset?: number;
2698
2702
  limit?: number;
2699
- /** The last resource ID from which to seek from (but not including). This is to be used instead of `offset`.
2703
+ /** Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`.
2700
2704
  */
2701
2705
  after?: string;
2702
2706
  /** The name of the organization. */
@@ -3767,7 +3771,7 @@ declare class MetricsAPI {
3767
3771
  * @param requestOptions - optional transport options
3768
3772
  * @returns promise of response
3769
3773
  */
3770
- getMetrics(request?: GetMetricsRequest, requestOptions?: RequestOptions): Promise<any>;
3774
+ getMetrics(request?: GetMetricsRequest, requestOptions?: RequestOptions): Promise<string>;
3771
3775
  }
3772
3776
 
3773
3777
  interface GetNotificationEndpointsRequest {
@@ -5799,7 +5803,7 @@ interface PostUsersIDPasswordRequest {
5799
5803
  interface GetUsersRequest {
5800
5804
  offset?: number;
5801
5805
  limit?: number;
5802
- /** The last resource ID from which to seek from (but not including). This is to be used instead of `offset`.
5806
+ /** Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`.
5803
5807
  */
5804
5808
  after?: string;
5805
5809
  name?: string;
@@ -4,7 +4,7 @@ import { AddResourceMemberRequestBody, Bucket, Buckets, LabelMapping, LabelRespo
4
4
  export interface GetBucketsRequest {
5
5
  offset?: number;
6
6
  limit?: number;
7
- /** The last resource ID from which to seek from (but not including). This is to be used instead of `offset`.
7
+ /** Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`.
8
8
  */
9
9
  after?: string;
10
10
  /** The name of the organization. */
@@ -19,6 +19,6 @@ export declare class MetricsAPI {
19
19
  * @param requestOptions - optional transport options
20
20
  * @returns promise of response
21
21
  */
22
- getMetrics(request?: GetMetricsRequest, requestOptions?: RequestOptions): Promise<any>;
22
+ getMetrics(request?: GetMetricsRequest, requestOptions?: RequestOptions): Promise<string>;
23
23
  }
24
24
  //# sourceMappingURL=MetricsAPI.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"MetricsAPI.d.ts","sourceRoot":"","sources":["../src/generated/MetricsAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,6BAA6B,CAAA;AACpD,OAAO,EAAU,cAAc,EAAC,MAAM,YAAY,CAAA;AAElD,MAAM,WAAW,iBAAiB;CAAG;AACrC;;GAEG;AACH,qBAAa,UAAU;IAErB,OAAO,CAAC,IAAI,CAAS;IAErB;;;OAGG;gBACS,QAAQ,EAAE,QAAQ;IAG9B;;;;;;OAMG;IACH,UAAU,CACR,OAAO,CAAC,EAAE,iBAAiB,EAC3B,cAAc,CAAC,EAAE,cAAc,GAC9B,OAAO,CAAC,GAAG,CAAC;CAGhB"}
1
+ {"version":3,"file":"MetricsAPI.d.ts","sourceRoot":"","sources":["../src/generated/MetricsAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,6BAA6B,CAAA;AACpD,OAAO,EAAU,cAAc,EAAC,MAAM,YAAY,CAAA;AAElD,MAAM,WAAW,iBAAiB;CAAG;AACrC;;GAEG;AACH,qBAAa,UAAU;IAErB,OAAO,CAAC,IAAI,CAAS;IAErB;;;OAGG;gBACS,QAAQ,EAAE,QAAQ;IAG9B;;;;;;OAMG;IACH,UAAU,CACR,OAAO,CAAC,EAAE,iBAAiB,EAC3B,cAAc,CAAC,EAAE,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC;CAGnB"}
@@ -14,7 +14,7 @@ export interface PostUsersIDPasswordRequest {
14
14
  export interface GetUsersRequest {
15
15
  offset?: number;
16
16
  limit?: number;
17
- /** The last resource ID from which to seek from (but not including). This is to be used instead of `offset`.
17
+ /** Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`.
18
18
  */
19
19
  after?: string;
20
20
  name?: string;
@@ -1,11 +1,11 @@
1
1
  export interface Error {
2
2
  /** code is the machine-readable error code. */
3
3
  readonly code: 'internal error' | 'not found' | 'conflict' | 'invalid' | 'unprocessable entity' | 'empty value' | 'unavailable' | 'forbidden' | 'too many requests' | 'unauthorized' | 'method not allowed' | 'request too large' | 'unsupported media type';
4
- /** message is a human-readable message. */
5
- readonly message: string;
6
- /** op describes the logical code operation during error. Useful for debugging. */
4
+ /** Human-readable message. */
5
+ readonly message?: string;
6
+ /** Describes the logical code operation when the error occurred. Useful for debugging. */
7
7
  readonly op?: string;
8
- /** err is a stack of errors that occurred during processing of the request. Useful for debugging. */
8
+ /** Stack of errors that occurred during processing of the request. Useful for debugging. */
9
9
  readonly err?: string;
10
10
  }
11
11
  export interface Routes {
@@ -43,17 +43,17 @@ export interface DBRPs {
43
43
  content?: DBRP[];
44
44
  }
45
45
  export interface DBRP {
46
- /** the mapping identifier */
46
+ /** ID of the DBRP mapping. */
47
47
  readonly id: string;
48
- /** the organization ID that owns this mapping. */
48
+ /** ID of the organization that owns this mapping. */
49
49
  orgID: string;
50
- /** the bucket ID used as target for the translation. */
50
+ /** ID of the bucket used as the target for the translation. */
51
51
  bucketID: string;
52
52
  /** InfluxDB v1 database */
53
53
  database: string;
54
54
  /** InfluxDB v1 retention policy */
55
55
  retention_policy: string;
56
- /** Specify if this mapping represents the default retention policy for the database specificed. */
56
+ /** Mapping represents the default retention policy for the database specified. */
57
57
  default: boolean;
58
58
  links?: Links;
59
59
  }
@@ -67,17 +67,17 @@ export interface Links {
67
67
  */
68
68
  export declare type Link = string;
69
69
  export interface DBRPCreate {
70
- /** the organization ID that owns this mapping. */
70
+ /** ID of the organization that owns this mapping. */
71
71
  orgID?: string;
72
- /** the organization that owns this mapping. */
72
+ /** Name of the organization that owns this mapping. */
73
73
  org?: string;
74
- /** the bucket ID used as target for the translation. */
74
+ /** ID of the bucket used as the target for the translation. */
75
75
  bucketID: string;
76
76
  /** InfluxDB v1 database */
77
77
  database: string;
78
78
  /** InfluxDB v1 retention policy */
79
79
  retention_policy: string;
80
- /** Specify if this mapping represents the default retention policy for the database specificed. */
80
+ /** Mapping represents the default retention policy for the database specified. */
81
81
  default?: boolean;
82
82
  }
83
83
  export interface DBRPGet {
@@ -191,19 +191,19 @@ export declare type ResourceOwner = UserResponse & {
191
191
  export interface LineProtocolError {
192
192
  /** Code is the machine-readable error code. */
193
193
  readonly code: 'internal error' | 'not found' | 'conflict' | 'invalid' | 'empty value' | 'unavailable';
194
- /** Message is a human-readable message. */
195
- readonly message: string;
196
- /** Op describes the logical code operation during error. Useful for debugging. */
197
- readonly op: string;
198
- /** Err is a stack of errors that occurred during processing of the request. Useful for debugging. */
199
- readonly err: string;
200
- /** First line within sent body containing malformed data */
194
+ /** Human-readable message. */
195
+ readonly message?: string;
196
+ /** Describes the logical code operation when the error occurred. Useful for debugging. */
197
+ readonly op?: string;
198
+ /** Stack of errors that occurred during processing of the request. Useful for debugging. */
199
+ readonly err?: string;
200
+ /** First line in the request body that contains malformed data. */
201
201
  readonly line?: number;
202
202
  }
203
203
  export interface LineProtocolLengthError {
204
204
  /** Code is the machine-readable error code. */
205
205
  readonly code: 'invalid';
206
- /** Message is a human-readable message. */
206
+ /** Human-readable message. */
207
207
  readonly message: string;
208
208
  }
209
209
  /**
@@ -372,18 +372,18 @@ export interface Axes {
372
372
  y: Axis;
373
373
  }
374
374
  /**
375
- * The description of a particular axis for a visualization.
375
+ * Axis used in a visualization.
376
376
  */
377
377
  export interface Axis {
378
- /** The extents of an axis in the form [lower, upper]. Clients determine whether bounds are to be inclusive or exclusive of their limits */
378
+ /** The extents of the axis in the form [lower, upper]. Clients determine whether bounds are inclusive or exclusive of their limits. */
379
379
  bounds?: string[];
380
- /** Label is a description of this Axis */
380
+ /** Description of the axis. */
381
381
  label?: string;
382
- /** Prefix represents a label prefix for formatting axis values. */
382
+ /** Label prefix for formatting axis values. */
383
383
  prefix?: string;
384
- /** Suffix represents a label suffix for formatting axis values. */
384
+ /** Label suffix for formatting axis values. */
385
385
  suffix?: string;
386
- /** Base represents the radix for formatting axis values. */
386
+ /** Radix for formatting axis values. */
387
387
  base?: '' | '2' | '10';
388
388
  scale?: AxisScale;
389
389
  }
@@ -607,8 +607,8 @@ export interface CheckBase {
607
607
  status?: TaskStatusType;
608
608
  /** An optional description of the check. */
609
609
  description?: string;
610
- /** Timestamp of latest scheduled, completed run, RFC3339. */
611
- readonly latestCompleted?: string;
610
+ /** Timestamp (in RFC3339 date/time format](https://datatracker.ietf.org/doc/html/rfc3339)) of the latest scheduled and completed run. */
611
+ readonly latestCompleted?: any;
612
612
  readonly lastRunStatus?: 'failed' | 'success' | 'canceled';
613
613
  readonly lastRunError?: string;
614
614
  labels?: Labels;
@@ -1311,17 +1311,17 @@ export interface Buckets {
1311
1311
  }
1312
1312
  export interface Bucket {
1313
1313
  readonly links?: {
1314
- /** URL to retrieve labels for this bucket */
1314
+ /** URL to retrieve labels for this bucket. */
1315
1315
  labels?: Link;
1316
- /** URL to retrieve members that can read this bucket */
1316
+ /** URL to retrieve members that can read this bucket. */
1317
1317
  members?: Link;
1318
- /** URL to retrieve parent organization for this bucket */
1318
+ /** URL to retrieve parent organization for this bucket. */
1319
1319
  org?: Link;
1320
1320
  /** URL to retrieve owners that can read and write to this bucket. */
1321
1321
  owners?: Link;
1322
- /** URL for this bucket */
1322
+ /** URL for this bucket. */
1323
1323
  self?: Link;
1324
- /** URL to write line protocol for this bucket */
1324
+ /** URL to write line protocol to this bucket. */
1325
1325
  write?: Link;
1326
1326
  };
1327
1327
  readonly id?: string;
@@ -1910,31 +1910,35 @@ export interface TemplateExportByName {
1910
1910
  }
1911
1911
  export interface Task {
1912
1912
  readonly id: string;
1913
- /** The type of task, this can be used for filtering tasks on list actions. */
1913
+ /** Type of the task, useful for filtering a task list. */
1914
1914
  type?: string;
1915
- /** The ID of the organization that owns this Task. */
1915
+ /** ID of the organization that owns the task. */
1916
1916
  orgID: string;
1917
- /** The name of the organization that owns this Task. */
1917
+ /** Name of the organization that owns the task. */
1918
1918
  org?: string;
1919
- /** The name of the task. */
1919
+ /** Name of the task. */
1920
1920
  name: string;
1921
- /** The ID of the user who owns this Task. */
1921
+ /** ID of the user who owns this Task. */
1922
1922
  ownerID?: string;
1923
- /** An optional description of the task. */
1923
+ /** Description of the task. */
1924
1924
  description?: string;
1925
1925
  status?: TaskStatusType;
1926
1926
  labels?: Labels;
1927
- /** The ID of the authorization used when this task communicates with the query engine. */
1927
+ /** ID of the authorization used when the task communicates with the query engine. */
1928
1928
  authorizationID?: string;
1929
- /** The Flux script to run for this task. */
1929
+ /** Flux script to run for this task. */
1930
1930
  flux: string;
1931
- /** A simple task repetition schedule; parsed from Flux. */
1931
+ /** Interval at which the task runs. `every` also determines when the task first runs, depending on the specified time.
1932
+ Value is a [duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals)). */
1932
1933
  every?: string;
1933
- /** A task repetition schedule in the form '* * * * * *'; parsed from Flux. */
1934
+ /** [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. Cron scheduling is based on system time.
1935
+ Value is a [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview). */
1934
1936
  cron?: string;
1935
- /** Duration to delay after the schedule, before executing the task; parsed from flux, if set to zero it will remove this option and use 0 as the default. */
1937
+ /** [Duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset.
1938
+ The value is a [duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals). */
1936
1939
  offset?: string;
1937
- /** Timestamp of latest scheduled, completed run, RFC3339. */
1940
+ /** Timestamp of the latest scheduled and completed run.
1941
+ Value is a timestamp in [RFC3339 date/time format](https://docs.influxdata.com/flux/v0.x/data-types/basic/time/#time-syntax). */
1938
1942
  readonly latestCompleted?: string;
1939
1943
  readonly lastRunStatus?: 'failed' | 'success' | 'canceled';
1940
1944
  readonly lastRunError?: string;
@@ -2035,7 +2039,7 @@ export declare type NotificationRuleDiscriminator = (SlackNotificationRule & {
2035
2039
  });
2036
2040
  export declare type SlackNotificationRule = NotificationRuleBase & SlackNotificationRuleBase;
2037
2041
  export interface NotificationRuleBase {
2038
- /** Timestamp of latest scheduled, completed run, RFC3339. */
2042
+ /** Timestamp (in RFC3339 date/time format](https://datatracker.ietf.org/doc/html/rfc3339)) of the latest scheduled and completed run. */
2039
2043
  readonly latestCompleted?: string;
2040
2044
  readonly lastRunStatus?: 'failed' | 'success' | 'canceled';
2041
2045
  readonly lastRunError?: string;
@@ -2205,18 +2209,18 @@ export interface OnboardingResponse {
2205
2209
  export declare type Authorization = AuthorizationUpdateRequest & {
2206
2210
  readonly createdAt?: string;
2207
2211
  readonly updatedAt?: string;
2208
- /** ID of org that authorization is scoped to. */
2212
+ /** ID of the organization that the authorization is scoped to. */
2209
2213
  orgID?: string;
2210
- /** List of permissions for an auth. An auth must have at least one Permission. */
2214
+ /** List of permissions for an authorization. An authorization must have at least one permission. */
2211
2215
  permissions?: Permission[];
2212
2216
  readonly id?: string;
2213
- /** Passed via the Authorization Header and Token Authentication type. */
2217
+ /** Token used to authenticate API requests. */
2214
2218
  readonly token?: string;
2215
- /** ID of user that created and owns the token. */
2219
+ /** ID of the user that created and owns the token. */
2216
2220
  readonly userID?: string;
2217
- /** Name of user that created and owns the token. */
2221
+ /** Name of the user that created and owns the token. */
2218
2222
  readonly user?: string;
2219
- /** Name of the org token is scoped to. */
2223
+ /** Name of the organization that the token is scoped to. */
2220
2224
  readonly org?: string;
2221
2225
  readonly links?: {
2222
2226
  readonly self?: Link;
@@ -2224,7 +2228,7 @@ export declare type Authorization = AuthorizationUpdateRequest & {
2224
2228
  };
2225
2229
  };
2226
2230
  export interface AuthorizationUpdateRequest {
2227
- /** If inactive the token is inactive and requests using the token will be rejected. */
2231
+ /** Status of the token. If `inactive`, requests using the token will be rejected. */
2228
2232
  status?: 'active' | 'inactive';
2229
2233
  /** A description of the token. */
2230
2234
  description?: string;