@botpress/client 0.10.1 → 0.11.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.
- package/dist/bundle.cjs +8 -8
- package/dist/bundle.cjs.map +4 -4
- package/dist/gen/api.d.ts +1486 -35
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +17 -1
- package/dist/gen/common.d.ts +1 -1
- package/dist/gen/configuration.d.ts +1 -1
- package/dist/gen/index.d.ts +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +3 -3
- package/dist/index.mjs +1 -1
- package/package.json +2 -2
package/dist/gen/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Botpress API
|
|
3
3
|
* API for Botpress Cloud
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.16.2
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -150,6 +150,12 @@ export interface Bot {
|
|
|
150
150
|
'recurringEvents': {
|
|
151
151
|
[key: string]: BotRecurringEventsValue;
|
|
152
152
|
};
|
|
153
|
+
/**
|
|
154
|
+
*
|
|
155
|
+
* @type {CreateBotBodySubscriptions}
|
|
156
|
+
* @memberof Bot
|
|
157
|
+
*/
|
|
158
|
+
'subscriptions': CreateBotBodySubscriptions;
|
|
153
159
|
/**
|
|
154
160
|
* Name of the [Bot](#schema_bot)
|
|
155
161
|
* @type {string}
|
|
@@ -404,6 +410,18 @@ export interface BotRecurringEventsValue {
|
|
|
404
410
|
'payload': {
|
|
405
411
|
[key: string]: any;
|
|
406
412
|
};
|
|
413
|
+
/**
|
|
414
|
+
* The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
|
|
415
|
+
* @type {number}
|
|
416
|
+
* @memberof BotRecurringEventsValue
|
|
417
|
+
*/
|
|
418
|
+
'failedAttempts': number;
|
|
419
|
+
/**
|
|
420
|
+
* The reason why the recurring event failed to run in the last attempt.
|
|
421
|
+
* @type {string}
|
|
422
|
+
* @memberof BotRecurringEventsValue
|
|
423
|
+
*/
|
|
424
|
+
'lastFailureReason': string | null;
|
|
407
425
|
}
|
|
408
426
|
/**
|
|
409
427
|
*
|
|
@@ -604,6 +622,48 @@ export interface ChangeWorkspacePlanResponse {
|
|
|
604
622
|
* @memberof ChangeWorkspacePlanResponse
|
|
605
623
|
*/
|
|
606
624
|
'spendingLimit': number;
|
|
625
|
+
/**
|
|
626
|
+
*
|
|
627
|
+
* @type {string}
|
|
628
|
+
* @memberof ChangeWorkspacePlanResponse
|
|
629
|
+
*/
|
|
630
|
+
'about'?: string;
|
|
631
|
+
/**
|
|
632
|
+
*
|
|
633
|
+
* @type {string}
|
|
634
|
+
* @memberof ChangeWorkspacePlanResponse
|
|
635
|
+
*/
|
|
636
|
+
'profilePicture'?: string;
|
|
637
|
+
/**
|
|
638
|
+
*
|
|
639
|
+
* @type {string}
|
|
640
|
+
* @memberof ChangeWorkspacePlanResponse
|
|
641
|
+
*/
|
|
642
|
+
'contactEmail'?: string;
|
|
643
|
+
/**
|
|
644
|
+
*
|
|
645
|
+
* @type {string}
|
|
646
|
+
* @memberof ChangeWorkspacePlanResponse
|
|
647
|
+
*/
|
|
648
|
+
'website'?: string;
|
|
649
|
+
/**
|
|
650
|
+
*
|
|
651
|
+
* @type {Array<string>}
|
|
652
|
+
* @memberof ChangeWorkspacePlanResponse
|
|
653
|
+
*/
|
|
654
|
+
'socialAccounts'?: Array<string>;
|
|
655
|
+
/**
|
|
656
|
+
*
|
|
657
|
+
* @type {boolean}
|
|
658
|
+
* @memberof ChangeWorkspacePlanResponse
|
|
659
|
+
*/
|
|
660
|
+
'isPublic'?: boolean;
|
|
661
|
+
/**
|
|
662
|
+
*
|
|
663
|
+
* @type {string}
|
|
664
|
+
* @memberof ChangeWorkspacePlanResponse
|
|
665
|
+
*/
|
|
666
|
+
'handle'?: string;
|
|
607
667
|
}
|
|
608
668
|
export declare const ChangeWorkspacePlanResponseAccountTypeEnum: {
|
|
609
669
|
readonly Free: "free";
|
|
@@ -697,6 +757,103 @@ export interface ChargeWorkspaceUnpaidInvoicesResponseFailedInvoicesInner {
|
|
|
697
757
|
*/
|
|
698
758
|
'failedReason': string;
|
|
699
759
|
}
|
|
760
|
+
/**
|
|
761
|
+
*
|
|
762
|
+
* @export
|
|
763
|
+
* @interface CheckHandleAvailabilityBody
|
|
764
|
+
*/
|
|
765
|
+
export interface CheckHandleAvailabilityBody {
|
|
766
|
+
/**
|
|
767
|
+
*
|
|
768
|
+
* @type {string}
|
|
769
|
+
* @memberof CheckHandleAvailabilityBody
|
|
770
|
+
*/
|
|
771
|
+
'handle': string;
|
|
772
|
+
}
|
|
773
|
+
/**
|
|
774
|
+
*
|
|
775
|
+
* @export
|
|
776
|
+
* @interface CheckHandleAvailabilityResponse
|
|
777
|
+
*/
|
|
778
|
+
export interface CheckHandleAvailabilityResponse {
|
|
779
|
+
/**
|
|
780
|
+
*
|
|
781
|
+
* @type {boolean}
|
|
782
|
+
* @memberof CheckHandleAvailabilityResponse
|
|
783
|
+
*/
|
|
784
|
+
'available': boolean;
|
|
785
|
+
/**
|
|
786
|
+
*
|
|
787
|
+
* @type {Array<string>}
|
|
788
|
+
* @memberof CheckHandleAvailabilityResponse
|
|
789
|
+
*/
|
|
790
|
+
'suggestions': Array<string>;
|
|
791
|
+
/**
|
|
792
|
+
*
|
|
793
|
+
* @type {string}
|
|
794
|
+
* @memberof CheckHandleAvailabilityResponse
|
|
795
|
+
*/
|
|
796
|
+
'usedBy'?: string;
|
|
797
|
+
}
|
|
798
|
+
/**
|
|
799
|
+
*
|
|
800
|
+
* @export
|
|
801
|
+
* @interface Column
|
|
802
|
+
*/
|
|
803
|
+
export interface Column {
|
|
804
|
+
/**
|
|
805
|
+
* Unique identifier for the column.
|
|
806
|
+
* @type {string}
|
|
807
|
+
* @memberof Column
|
|
808
|
+
*/
|
|
809
|
+
'id'?: string;
|
|
810
|
+
/**
|
|
811
|
+
* Name of the column, must be within length limits.
|
|
812
|
+
* @type {string}
|
|
813
|
+
* @memberof Column
|
|
814
|
+
*/
|
|
815
|
+
'name': string;
|
|
816
|
+
/**
|
|
817
|
+
* Optional descriptive text about the column.
|
|
818
|
+
* @type {string}
|
|
819
|
+
* @memberof Column
|
|
820
|
+
*/
|
|
821
|
+
'description'?: string;
|
|
822
|
+
/**
|
|
823
|
+
* Indicates if the column is vectorized and searchable.
|
|
824
|
+
* @type {boolean}
|
|
825
|
+
* @memberof Column
|
|
826
|
+
*/
|
|
827
|
+
'searchable'?: boolean;
|
|
828
|
+
/**
|
|
829
|
+
* Specifies the data type of the column. Use \"object\" for complex data structures.
|
|
830
|
+
* @type {string}
|
|
831
|
+
* @memberof Column
|
|
832
|
+
*/
|
|
833
|
+
'type': ColumnTypeEnum;
|
|
834
|
+
/**
|
|
835
|
+
* TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\"
|
|
836
|
+
* @type {string}
|
|
837
|
+
* @memberof Column
|
|
838
|
+
*/
|
|
839
|
+
'typings'?: string;
|
|
840
|
+
/**
|
|
841
|
+
*
|
|
842
|
+
* @type {{ [key: string]: any; }}
|
|
843
|
+
* @memberof Column
|
|
844
|
+
*/
|
|
845
|
+
'schema'?: {
|
|
846
|
+
[key: string]: any;
|
|
847
|
+
};
|
|
848
|
+
}
|
|
849
|
+
export declare const ColumnTypeEnum: {
|
|
850
|
+
readonly String: "string";
|
|
851
|
+
readonly Number: "number";
|
|
852
|
+
readonly Boolean: "boolean";
|
|
853
|
+
readonly Date: "date";
|
|
854
|
+
readonly Object: "object";
|
|
855
|
+
};
|
|
856
|
+
export type ColumnTypeEnum = typeof ColumnTypeEnum[keyof typeof ColumnTypeEnum];
|
|
700
857
|
/**
|
|
701
858
|
*
|
|
702
859
|
* @export
|
|
@@ -722,6 +879,12 @@ export interface Conversation {
|
|
|
722
879
|
* @memberof Conversation
|
|
723
880
|
*/
|
|
724
881
|
'id': string;
|
|
882
|
+
/**
|
|
883
|
+
* Id of the current [Task](#schema_task)
|
|
884
|
+
* @type {string}
|
|
885
|
+
* @memberof Conversation
|
|
886
|
+
*/
|
|
887
|
+
'currentTaskId'?: string;
|
|
725
888
|
/**
|
|
726
889
|
* Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
|
|
727
890
|
* @type {string}
|
|
@@ -785,6 +948,12 @@ export interface CreateBotBody {
|
|
|
785
948
|
'recurringEvents'?: {
|
|
786
949
|
[key: string]: CreateBotBodyRecurringEventsValue;
|
|
787
950
|
};
|
|
951
|
+
/**
|
|
952
|
+
*
|
|
953
|
+
* @type {CreateBotBodySubscriptions}
|
|
954
|
+
* @memberof CreateBotBody
|
|
955
|
+
*/
|
|
956
|
+
'subscriptions'?: CreateBotBodySubscriptions;
|
|
788
957
|
/**
|
|
789
958
|
*
|
|
790
959
|
* @type {CreateBotBodyConfiguration}
|
|
@@ -982,6 +1151,23 @@ export declare const CreateBotBodyStatesValueTypeEnum: {
|
|
|
982
1151
|
readonly Bot: "bot";
|
|
983
1152
|
};
|
|
984
1153
|
export type CreateBotBodyStatesValueTypeEnum = typeof CreateBotBodyStatesValueTypeEnum[keyof typeof CreateBotBodyStatesValueTypeEnum];
|
|
1154
|
+
/**
|
|
1155
|
+
* Subscriptions of the bot
|
|
1156
|
+
* @export
|
|
1157
|
+
* @interface CreateBotBodySubscriptions
|
|
1158
|
+
*/
|
|
1159
|
+
export interface CreateBotBodySubscriptions {
|
|
1160
|
+
/**
|
|
1161
|
+
* Events that the bot is currently subscribed on (ex: \"slack:reactionAdded\"). If null, the bot is subscribed to all events.
|
|
1162
|
+
* @type {{ [key: string]: { [key: string]: any; }; }}
|
|
1163
|
+
* @memberof CreateBotBodySubscriptions
|
|
1164
|
+
*/
|
|
1165
|
+
'events': {
|
|
1166
|
+
[key: string]: {
|
|
1167
|
+
[key: string]: any;
|
|
1168
|
+
};
|
|
1169
|
+
} | null;
|
|
1170
|
+
}
|
|
985
1171
|
/**
|
|
986
1172
|
*
|
|
987
1173
|
* @export
|
|
@@ -1264,6 +1450,14 @@ export interface CreateIntegrationBody {
|
|
|
1264
1450
|
* @memberof CreateIntegrationBody
|
|
1265
1451
|
*/
|
|
1266
1452
|
'user'?: CreateIntegrationBodyUser;
|
|
1453
|
+
/**
|
|
1454
|
+
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
1455
|
+
* @type {{ [key: string]: string; }}
|
|
1456
|
+
* @memberof CreateIntegrationBody
|
|
1457
|
+
*/
|
|
1458
|
+
'secrets'?: {
|
|
1459
|
+
[key: string]: string;
|
|
1460
|
+
};
|
|
1267
1461
|
/**
|
|
1268
1462
|
* JavaScript code of the integration
|
|
1269
1463
|
* @type {string}
|
|
@@ -1722,6 +1916,84 @@ export interface CreatePersonalAccessTokenResponsePat {
|
|
|
1722
1916
|
*/
|
|
1723
1917
|
'value': string;
|
|
1724
1918
|
}
|
|
1919
|
+
/**
|
|
1920
|
+
*
|
|
1921
|
+
* @export
|
|
1922
|
+
* @interface CreateTaskBody
|
|
1923
|
+
*/
|
|
1924
|
+
export interface CreateTaskBody {
|
|
1925
|
+
/**
|
|
1926
|
+
* Title describing the task
|
|
1927
|
+
* @type {string}
|
|
1928
|
+
* @memberof CreateTaskBody
|
|
1929
|
+
*/
|
|
1930
|
+
'title': string;
|
|
1931
|
+
/**
|
|
1932
|
+
* All the notes related to the execution of the current task
|
|
1933
|
+
* @type {string}
|
|
1934
|
+
* @memberof CreateTaskBody
|
|
1935
|
+
*/
|
|
1936
|
+
'instruction'?: string;
|
|
1937
|
+
/**
|
|
1938
|
+
* Type of the task
|
|
1939
|
+
* @type {string}
|
|
1940
|
+
* @memberof CreateTaskBody
|
|
1941
|
+
*/
|
|
1942
|
+
'type': string;
|
|
1943
|
+
/**
|
|
1944
|
+
* Content related to the task
|
|
1945
|
+
* @type {{ [key: string]: any; }}
|
|
1946
|
+
* @memberof CreateTaskBody
|
|
1947
|
+
*/
|
|
1948
|
+
'data'?: {
|
|
1949
|
+
[key: string]: any;
|
|
1950
|
+
};
|
|
1951
|
+
/**
|
|
1952
|
+
* Parent task id is the parent task that created this task
|
|
1953
|
+
* @type {string}
|
|
1954
|
+
* @memberof CreateTaskBody
|
|
1955
|
+
*/
|
|
1956
|
+
'parentTaskId'?: string;
|
|
1957
|
+
/**
|
|
1958
|
+
* Conversation id related to this task
|
|
1959
|
+
* @type {string}
|
|
1960
|
+
* @memberof CreateTaskBody
|
|
1961
|
+
*/
|
|
1962
|
+
'conversationId': string;
|
|
1963
|
+
/**
|
|
1964
|
+
* Specific user related to this task
|
|
1965
|
+
* @type {string}
|
|
1966
|
+
* @memberof CreateTaskBody
|
|
1967
|
+
*/
|
|
1968
|
+
'userId'?: string;
|
|
1969
|
+
/**
|
|
1970
|
+
* The timeout date where the task should be failed in the ISO 8601 format
|
|
1971
|
+
* @type {string}
|
|
1972
|
+
* @memberof CreateTaskBody
|
|
1973
|
+
*/
|
|
1974
|
+
'timeoutAt'?: string;
|
|
1975
|
+
/**
|
|
1976
|
+
* Tags for the [Task](#schema_task)
|
|
1977
|
+
* @type {{ [key: string]: string; }}
|
|
1978
|
+
* @memberof CreateTaskBody
|
|
1979
|
+
*/
|
|
1980
|
+
'tags'?: {
|
|
1981
|
+
[key: string]: string;
|
|
1982
|
+
};
|
|
1983
|
+
}
|
|
1984
|
+
/**
|
|
1985
|
+
*
|
|
1986
|
+
* @export
|
|
1987
|
+
* @interface CreateTaskResponse
|
|
1988
|
+
*/
|
|
1989
|
+
export interface CreateTaskResponse {
|
|
1990
|
+
/**
|
|
1991
|
+
*
|
|
1992
|
+
* @type {Task}
|
|
1993
|
+
* @memberof CreateTaskResponse
|
|
1994
|
+
*/
|
|
1995
|
+
'task': Task;
|
|
1996
|
+
}
|
|
1725
1997
|
/**
|
|
1726
1998
|
*
|
|
1727
1999
|
* @export
|
|
@@ -1834,6 +2106,12 @@ export interface CreateWorkspaceMemberResponse {
|
|
|
1834
2106
|
* @memberof CreateWorkspaceMemberResponse
|
|
1835
2107
|
*/
|
|
1836
2108
|
'email': string;
|
|
2109
|
+
/**
|
|
2110
|
+
*
|
|
2111
|
+
* @type {string}
|
|
2112
|
+
* @memberof CreateWorkspaceMemberResponse
|
|
2113
|
+
*/
|
|
2114
|
+
'createdAt': string;
|
|
1837
2115
|
/**
|
|
1838
2116
|
*
|
|
1839
2117
|
* @type {string}
|
|
@@ -1922,6 +2200,48 @@ export interface CreateWorkspaceResponse {
|
|
|
1922
2200
|
* @memberof CreateWorkspaceResponse
|
|
1923
2201
|
*/
|
|
1924
2202
|
'spendingLimit': number;
|
|
2203
|
+
/**
|
|
2204
|
+
*
|
|
2205
|
+
* @type {string}
|
|
2206
|
+
* @memberof CreateWorkspaceResponse
|
|
2207
|
+
*/
|
|
2208
|
+
'about'?: string;
|
|
2209
|
+
/**
|
|
2210
|
+
*
|
|
2211
|
+
* @type {string}
|
|
2212
|
+
* @memberof CreateWorkspaceResponse
|
|
2213
|
+
*/
|
|
2214
|
+
'profilePicture'?: string;
|
|
2215
|
+
/**
|
|
2216
|
+
*
|
|
2217
|
+
* @type {string}
|
|
2218
|
+
* @memberof CreateWorkspaceResponse
|
|
2219
|
+
*/
|
|
2220
|
+
'contactEmail'?: string;
|
|
2221
|
+
/**
|
|
2222
|
+
*
|
|
2223
|
+
* @type {string}
|
|
2224
|
+
* @memberof CreateWorkspaceResponse
|
|
2225
|
+
*/
|
|
2226
|
+
'website'?: string;
|
|
2227
|
+
/**
|
|
2228
|
+
*
|
|
2229
|
+
* @type {Array<string>}
|
|
2230
|
+
* @memberof CreateWorkspaceResponse
|
|
2231
|
+
*/
|
|
2232
|
+
'socialAccounts'?: Array<string>;
|
|
2233
|
+
/**
|
|
2234
|
+
*
|
|
2235
|
+
* @type {boolean}
|
|
2236
|
+
* @memberof CreateWorkspaceResponse
|
|
2237
|
+
*/
|
|
2238
|
+
'isPublic'?: boolean;
|
|
2239
|
+
/**
|
|
2240
|
+
*
|
|
2241
|
+
* @type {string}
|
|
2242
|
+
* @memberof CreateWorkspaceResponse
|
|
2243
|
+
*/
|
|
2244
|
+
'handle'?: string;
|
|
1925
2245
|
}
|
|
1926
2246
|
export declare const CreateWorkspaceResponseAccountTypeEnum: {
|
|
1927
2247
|
readonly Free: "free";
|
|
@@ -1989,6 +2309,38 @@ export interface Event {
|
|
|
1989
2309
|
* @memberof Event
|
|
1990
2310
|
*/
|
|
1991
2311
|
'messageId'?: string;
|
|
2312
|
+
/**
|
|
2313
|
+
*
|
|
2314
|
+
* @type {string}
|
|
2315
|
+
* @memberof Event
|
|
2316
|
+
*/
|
|
2317
|
+
'status': EventStatusEnum;
|
|
2318
|
+
/**
|
|
2319
|
+
* Reason why the event failed to be processed
|
|
2320
|
+
* @type {string}
|
|
2321
|
+
* @memberof Event
|
|
2322
|
+
*/
|
|
2323
|
+
'failureReason': string | null;
|
|
2324
|
+
}
|
|
2325
|
+
export declare const EventStatusEnum: {
|
|
2326
|
+
readonly Pending: "pending";
|
|
2327
|
+
readonly Processed: "processed";
|
|
2328
|
+
readonly Ignored: "ignored";
|
|
2329
|
+
readonly Failed: "failed";
|
|
2330
|
+
};
|
|
2331
|
+
export type EventStatusEnum = typeof EventStatusEnum[keyof typeof EventStatusEnum];
|
|
2332
|
+
/**
|
|
2333
|
+
*
|
|
2334
|
+
* @export
|
|
2335
|
+
* @interface GetAccountPreferenceResponse
|
|
2336
|
+
*/
|
|
2337
|
+
export interface GetAccountPreferenceResponse {
|
|
2338
|
+
/**
|
|
2339
|
+
*
|
|
2340
|
+
* @type {any}
|
|
2341
|
+
* @memberof GetAccountPreferenceResponse
|
|
2342
|
+
*/
|
|
2343
|
+
'value'?: any | null;
|
|
1992
2344
|
}
|
|
1993
2345
|
/**
|
|
1994
2346
|
*
|
|
@@ -2602,6 +2954,19 @@ export interface GetStateResponse {
|
|
|
2602
2954
|
*/
|
|
2603
2955
|
'state': State;
|
|
2604
2956
|
}
|
|
2957
|
+
/**
|
|
2958
|
+
*
|
|
2959
|
+
* @export
|
|
2960
|
+
* @interface GetTaskResponse
|
|
2961
|
+
*/
|
|
2962
|
+
export interface GetTaskResponse {
|
|
2963
|
+
/**
|
|
2964
|
+
*
|
|
2965
|
+
* @type {Task}
|
|
2966
|
+
* @memberof GetTaskResponse
|
|
2967
|
+
*/
|
|
2968
|
+
'task': Task;
|
|
2969
|
+
}
|
|
2605
2970
|
/**
|
|
2606
2971
|
*
|
|
2607
2972
|
* @export
|
|
@@ -2873,16 +3238,58 @@ export interface GetWorkspaceResponse {
|
|
|
2873
3238
|
* @memberof GetWorkspaceResponse
|
|
2874
3239
|
*/
|
|
2875
3240
|
'spendingLimit': number;
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
|
|
2879
|
-
|
|
2880
|
-
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
3241
|
+
/**
|
|
3242
|
+
*
|
|
3243
|
+
* @type {string}
|
|
3244
|
+
* @memberof GetWorkspaceResponse
|
|
3245
|
+
*/
|
|
3246
|
+
'about'?: string;
|
|
3247
|
+
/**
|
|
3248
|
+
*
|
|
3249
|
+
* @type {string}
|
|
3250
|
+
* @memberof GetWorkspaceResponse
|
|
3251
|
+
*/
|
|
3252
|
+
'profilePicture'?: string;
|
|
3253
|
+
/**
|
|
3254
|
+
*
|
|
3255
|
+
* @type {string}
|
|
3256
|
+
* @memberof GetWorkspaceResponse
|
|
3257
|
+
*/
|
|
3258
|
+
'contactEmail'?: string;
|
|
3259
|
+
/**
|
|
3260
|
+
*
|
|
3261
|
+
* @type {string}
|
|
3262
|
+
* @memberof GetWorkspaceResponse
|
|
3263
|
+
*/
|
|
3264
|
+
'website'?: string;
|
|
3265
|
+
/**
|
|
3266
|
+
*
|
|
3267
|
+
* @type {Array<string>}
|
|
3268
|
+
* @memberof GetWorkspaceResponse
|
|
3269
|
+
*/
|
|
3270
|
+
'socialAccounts'?: Array<string>;
|
|
3271
|
+
/**
|
|
3272
|
+
*
|
|
3273
|
+
* @type {boolean}
|
|
3274
|
+
* @memberof GetWorkspaceResponse
|
|
3275
|
+
*/
|
|
3276
|
+
'isPublic'?: boolean;
|
|
3277
|
+
/**
|
|
3278
|
+
*
|
|
3279
|
+
* @type {string}
|
|
3280
|
+
* @memberof GetWorkspaceResponse
|
|
3281
|
+
*/
|
|
3282
|
+
'handle'?: string;
|
|
3283
|
+
}
|
|
3284
|
+
export declare const GetWorkspaceResponseAccountTypeEnum: {
|
|
3285
|
+
readonly Free: "free";
|
|
3286
|
+
readonly Premium: "premium";
|
|
3287
|
+
};
|
|
3288
|
+
export type GetWorkspaceResponseAccountTypeEnum = typeof GetWorkspaceResponseAccountTypeEnum[keyof typeof GetWorkspaceResponseAccountTypeEnum];
|
|
3289
|
+
export declare const GetWorkspaceResponseBillingVersionEnum: {
|
|
3290
|
+
readonly V1: "v1";
|
|
3291
|
+
readonly V2: "v2";
|
|
3292
|
+
};
|
|
2886
3293
|
export type GetWorkspaceResponseBillingVersionEnum = typeof GetWorkspaceResponseBillingVersionEnum[keyof typeof GetWorkspaceResponseBillingVersionEnum];
|
|
2887
3294
|
export declare const GetWorkspaceResponsePlanEnum: {
|
|
2888
3295
|
readonly Community: "community";
|
|
@@ -3006,6 +3413,12 @@ export interface Integration {
|
|
|
3006
3413
|
* @memberof Integration
|
|
3007
3414
|
*/
|
|
3008
3415
|
'readmeUrl': string;
|
|
3416
|
+
/**
|
|
3417
|
+
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
3418
|
+
* @type {Array<string>}
|
|
3419
|
+
* @memberof Integration
|
|
3420
|
+
*/
|
|
3421
|
+
'secrets': Array<string>;
|
|
3009
3422
|
}
|
|
3010
3423
|
/**
|
|
3011
3424
|
* Channel definition
|
|
@@ -3756,6 +4169,25 @@ export interface ListPublicIntegrationsResponseIntegrationsInner {
|
|
|
3756
4169
|
*/
|
|
3757
4170
|
'iconUrl': string;
|
|
3758
4171
|
}
|
|
4172
|
+
/**
|
|
4173
|
+
*
|
|
4174
|
+
* @export
|
|
4175
|
+
* @interface ListTasksResponse
|
|
4176
|
+
*/
|
|
4177
|
+
export interface ListTasksResponse {
|
|
4178
|
+
/**
|
|
4179
|
+
*
|
|
4180
|
+
* @type {Array<Task>}
|
|
4181
|
+
* @memberof ListTasksResponse
|
|
4182
|
+
*/
|
|
4183
|
+
'tasks': Array<Task>;
|
|
4184
|
+
/**
|
|
4185
|
+
*
|
|
4186
|
+
* @type {ListConversationsResponseMeta}
|
|
4187
|
+
* @memberof ListTasksResponse
|
|
4188
|
+
*/
|
|
4189
|
+
'meta': ListConversationsResponseMeta;
|
|
4190
|
+
}
|
|
3759
4191
|
/**
|
|
3760
4192
|
*
|
|
3761
4193
|
* @export
|
|
@@ -3929,6 +4361,12 @@ export interface ListWorkspaceMembersResponseMembersInner {
|
|
|
3929
4361
|
* @memberof ListWorkspaceMembersResponseMembersInner
|
|
3930
4362
|
*/
|
|
3931
4363
|
'email': string;
|
|
4364
|
+
/**
|
|
4365
|
+
*
|
|
4366
|
+
* @type {string}
|
|
4367
|
+
* @memberof ListWorkspaceMembersResponseMembersInner
|
|
4368
|
+
*/
|
|
4369
|
+
'createdAt': string;
|
|
3932
4370
|
/**
|
|
3933
4371
|
*
|
|
3934
4372
|
* @type {string}
|
|
@@ -4177,6 +4615,38 @@ export interface PatchStateResponse {
|
|
|
4177
4615
|
*/
|
|
4178
4616
|
'state': State;
|
|
4179
4617
|
}
|
|
4618
|
+
/**
|
|
4619
|
+
*
|
|
4620
|
+
* @export
|
|
4621
|
+
* @interface Row
|
|
4622
|
+
*/
|
|
4623
|
+
export interface Row {
|
|
4624
|
+
[key: string]: any;
|
|
4625
|
+
/**
|
|
4626
|
+
* Unique identifier for the row.
|
|
4627
|
+
* @type {number}
|
|
4628
|
+
* @memberof Row
|
|
4629
|
+
*/
|
|
4630
|
+
'id': number;
|
|
4631
|
+
/**
|
|
4632
|
+
* Timestamp of row creation.
|
|
4633
|
+
* @type {string}
|
|
4634
|
+
* @memberof Row
|
|
4635
|
+
*/
|
|
4636
|
+
'createdAt'?: string;
|
|
4637
|
+
/**
|
|
4638
|
+
* Timestamp of the last row update.
|
|
4639
|
+
* @type {string}
|
|
4640
|
+
* @memberof Row
|
|
4641
|
+
*/
|
|
4642
|
+
'updatedAt'?: string;
|
|
4643
|
+
/**
|
|
4644
|
+
* Optional numeric value indicating similarity, when using findTableRows.
|
|
4645
|
+
* @type {number}
|
|
4646
|
+
* @memberof Row
|
|
4647
|
+
*/
|
|
4648
|
+
'similarity'?: number;
|
|
4649
|
+
}
|
|
4180
4650
|
/**
|
|
4181
4651
|
*
|
|
4182
4652
|
* @export
|
|
@@ -4214,12 +4684,23 @@ export interface RunVrlResponse {
|
|
|
4214
4684
|
};
|
|
4215
4685
|
/**
|
|
4216
4686
|
*
|
|
4217
|
-
* @type {
|
|
4687
|
+
* @type {any}
|
|
4218
4688
|
* @memberof RunVrlResponse
|
|
4219
4689
|
*/
|
|
4220
|
-
'result'
|
|
4221
|
-
|
|
4222
|
-
|
|
4690
|
+
'result'?: any | null;
|
|
4691
|
+
}
|
|
4692
|
+
/**
|
|
4693
|
+
*
|
|
4694
|
+
* @export
|
|
4695
|
+
* @interface SetAccountPreferenceBody
|
|
4696
|
+
*/
|
|
4697
|
+
export interface SetAccountPreferenceBody {
|
|
4698
|
+
/**
|
|
4699
|
+
*
|
|
4700
|
+
* @type {any}
|
|
4701
|
+
* @memberof SetAccountPreferenceBody
|
|
4702
|
+
*/
|
|
4703
|
+
'value'?: any | null;
|
|
4223
4704
|
}
|
|
4224
4705
|
/**
|
|
4225
4706
|
*
|
|
@@ -4391,6 +4872,278 @@ export declare const StateTypeEnum: {
|
|
|
4391
4872
|
readonly Integration: "integration";
|
|
4392
4873
|
};
|
|
4393
4874
|
export type StateTypeEnum = typeof StateTypeEnum[keyof typeof StateTypeEnum];
|
|
4875
|
+
/**
|
|
4876
|
+
*
|
|
4877
|
+
* @export
|
|
4878
|
+
* @interface Table
|
|
4879
|
+
*/
|
|
4880
|
+
export interface Table {
|
|
4881
|
+
/**
|
|
4882
|
+
* Unique identifier for the table
|
|
4883
|
+
* @type {string}
|
|
4884
|
+
* @memberof Table
|
|
4885
|
+
*/
|
|
4886
|
+
'id': string;
|
|
4887
|
+
/**
|
|
4888
|
+
* Required. This name is used to identify your table.
|
|
4889
|
+
* @type {string}
|
|
4890
|
+
* @memberof Table
|
|
4891
|
+
*/
|
|
4892
|
+
'name': string;
|
|
4893
|
+
/**
|
|
4894
|
+
* The \'factor\' multiplies the row\'s data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.
|
|
4895
|
+
* @type {number}
|
|
4896
|
+
* @memberof Table
|
|
4897
|
+
*/
|
|
4898
|
+
'factor'?: number;
|
|
4899
|
+
/**
|
|
4900
|
+
*
|
|
4901
|
+
* @type {TableSchema}
|
|
4902
|
+
* @memberof Table
|
|
4903
|
+
*/
|
|
4904
|
+
'schema': TableSchema;
|
|
4905
|
+
/**
|
|
4906
|
+
* Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
|
|
4907
|
+
* @type {{ [key: string]: string; }}
|
|
4908
|
+
* @memberof Table
|
|
4909
|
+
*/
|
|
4910
|
+
'tags'?: {
|
|
4911
|
+
[key: string]: string;
|
|
4912
|
+
};
|
|
4913
|
+
/**
|
|
4914
|
+
* Timestamp of table creation.
|
|
4915
|
+
* @type {string}
|
|
4916
|
+
* @memberof Table
|
|
4917
|
+
*/
|
|
4918
|
+
'createdAt'?: string;
|
|
4919
|
+
/**
|
|
4920
|
+
* Timestamp of the last table update.
|
|
4921
|
+
* @type {string}
|
|
4922
|
+
* @memberof Table
|
|
4923
|
+
*/
|
|
4924
|
+
'updatedAt'?: string;
|
|
4925
|
+
}
|
|
4926
|
+
/**
|
|
4927
|
+
*
|
|
4928
|
+
* @export
|
|
4929
|
+
* @interface TableSchema
|
|
4930
|
+
*/
|
|
4931
|
+
export interface TableSchema {
|
|
4932
|
+
/**
|
|
4933
|
+
*
|
|
4934
|
+
* @type {string}
|
|
4935
|
+
* @memberof TableSchema
|
|
4936
|
+
*/
|
|
4937
|
+
'$schema': string;
|
|
4938
|
+
/**
|
|
4939
|
+
* List of keys/columns in the table.
|
|
4940
|
+
* @type {{ [key: string]: TableSchemaPropertiesValue; }}
|
|
4941
|
+
* @memberof TableSchema
|
|
4942
|
+
*/
|
|
4943
|
+
'properties': {
|
|
4944
|
+
[key: string]: TableSchemaPropertiesValue;
|
|
4945
|
+
};
|
|
4946
|
+
/**
|
|
4947
|
+
*
|
|
4948
|
+
* @type {boolean}
|
|
4949
|
+
* @memberof TableSchema
|
|
4950
|
+
*/
|
|
4951
|
+
'additionalProperties': boolean;
|
|
4952
|
+
/**
|
|
4953
|
+
* Array of required properties.
|
|
4954
|
+
* @type {Array<string>}
|
|
4955
|
+
* @memberof TableSchema
|
|
4956
|
+
*/
|
|
4957
|
+
'required'?: Array<string>;
|
|
4958
|
+
/**
|
|
4959
|
+
*
|
|
4960
|
+
* @type {string}
|
|
4961
|
+
* @memberof TableSchema
|
|
4962
|
+
*/
|
|
4963
|
+
'type': TableSchemaTypeEnum;
|
|
4964
|
+
}
|
|
4965
|
+
export declare const TableSchemaTypeEnum: {
|
|
4966
|
+
readonly Object: "object";
|
|
4967
|
+
};
|
|
4968
|
+
export type TableSchemaTypeEnum = typeof TableSchemaTypeEnum[keyof typeof TableSchemaTypeEnum];
|
|
4969
|
+
/**
|
|
4970
|
+
*
|
|
4971
|
+
* @export
|
|
4972
|
+
* @interface TableSchemaPropertiesValue
|
|
4973
|
+
*/
|
|
4974
|
+
export interface TableSchemaPropertiesValue {
|
|
4975
|
+
/**
|
|
4976
|
+
*
|
|
4977
|
+
* @type {string}
|
|
4978
|
+
* @memberof TableSchemaPropertiesValue
|
|
4979
|
+
*/
|
|
4980
|
+
'type': TableSchemaPropertiesValueTypeEnum;
|
|
4981
|
+
/**
|
|
4982
|
+
*
|
|
4983
|
+
* @type {string}
|
|
4984
|
+
* @memberof TableSchemaPropertiesValue
|
|
4985
|
+
*/
|
|
4986
|
+
'format'?: TableSchemaPropertiesValueFormatEnum;
|
|
4987
|
+
/**
|
|
4988
|
+
*
|
|
4989
|
+
* @type {string}
|
|
4990
|
+
* @memberof TableSchemaPropertiesValue
|
|
4991
|
+
*/
|
|
4992
|
+
'description'?: string;
|
|
4993
|
+
/**
|
|
4994
|
+
*
|
|
4995
|
+
* @type {boolean}
|
|
4996
|
+
* @memberof TableSchemaPropertiesValue
|
|
4997
|
+
*/
|
|
4998
|
+
'nullable'?: boolean;
|
|
4999
|
+
/**
|
|
5000
|
+
*
|
|
5001
|
+
* @type {TableSchemaPropertiesValueXZui}
|
|
5002
|
+
* @memberof TableSchemaPropertiesValue
|
|
5003
|
+
*/
|
|
5004
|
+
'x-zui': TableSchemaPropertiesValueXZui;
|
|
5005
|
+
}
|
|
5006
|
+
export declare const TableSchemaPropertiesValueTypeEnum: {
|
|
5007
|
+
readonly String: "string";
|
|
5008
|
+
readonly Number: "number";
|
|
5009
|
+
readonly Boolean: "boolean";
|
|
5010
|
+
readonly Object: "object";
|
|
5011
|
+
readonly Null: "null";
|
|
5012
|
+
};
|
|
5013
|
+
export type TableSchemaPropertiesValueTypeEnum = typeof TableSchemaPropertiesValueTypeEnum[keyof typeof TableSchemaPropertiesValueTypeEnum];
|
|
5014
|
+
export declare const TableSchemaPropertiesValueFormatEnum: {
|
|
5015
|
+
readonly DateTime: "date-time";
|
|
5016
|
+
};
|
|
5017
|
+
export type TableSchemaPropertiesValueFormatEnum = typeof TableSchemaPropertiesValueFormatEnum[keyof typeof TableSchemaPropertiesValueFormatEnum];
|
|
5018
|
+
/**
|
|
5019
|
+
*
|
|
5020
|
+
* @export
|
|
5021
|
+
* @interface TableSchemaPropertiesValueXZui
|
|
5022
|
+
*/
|
|
5023
|
+
export interface TableSchemaPropertiesValueXZui {
|
|
5024
|
+
/**
|
|
5025
|
+
*
|
|
5026
|
+
* @type {number}
|
|
5027
|
+
* @memberof TableSchemaPropertiesValueXZui
|
|
5028
|
+
*/
|
|
5029
|
+
'index': number;
|
|
5030
|
+
/**
|
|
5031
|
+
* Indicates if the column is vectorized and searchable.
|
|
5032
|
+
* @type {boolean}
|
|
5033
|
+
* @memberof TableSchemaPropertiesValueXZui
|
|
5034
|
+
*/
|
|
5035
|
+
'searchable'?: boolean;
|
|
5036
|
+
/**
|
|
5037
|
+
* TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\"
|
|
5038
|
+
* @type {string}
|
|
5039
|
+
* @memberof TableSchemaPropertiesValueXZui
|
|
5040
|
+
*/
|
|
5041
|
+
'typings'?: string;
|
|
5042
|
+
}
|
|
5043
|
+
/**
|
|
5044
|
+
* Task definition
|
|
5045
|
+
* @export
|
|
5046
|
+
* @interface Task
|
|
5047
|
+
*/
|
|
5048
|
+
export interface Task {
|
|
5049
|
+
/**
|
|
5050
|
+
* ID of the [Conversation](#schema_conversation)
|
|
5051
|
+
* @type {string}
|
|
5052
|
+
* @memberof Task
|
|
5053
|
+
*/
|
|
5054
|
+
'id': string;
|
|
5055
|
+
/**
|
|
5056
|
+
* Title describing the task
|
|
5057
|
+
* @type {string}
|
|
5058
|
+
* @memberof Task
|
|
5059
|
+
*/
|
|
5060
|
+
'title': string;
|
|
5061
|
+
/**
|
|
5062
|
+
* All the notes related to the execution of the current task
|
|
5063
|
+
* @type {string}
|
|
5064
|
+
* @memberof Task
|
|
5065
|
+
*/
|
|
5066
|
+
'instruction': string;
|
|
5067
|
+
/**
|
|
5068
|
+
* Type of the task
|
|
5069
|
+
* @type {string}
|
|
5070
|
+
* @memberof Task
|
|
5071
|
+
*/
|
|
5072
|
+
'type': string;
|
|
5073
|
+
/**
|
|
5074
|
+
* Content related to the task
|
|
5075
|
+
* @type {{ [key: string]: any; }}
|
|
5076
|
+
* @memberof Task
|
|
5077
|
+
*/
|
|
5078
|
+
'data': {
|
|
5079
|
+
[key: string]: any;
|
|
5080
|
+
};
|
|
5081
|
+
/**
|
|
5082
|
+
* Status of the task
|
|
5083
|
+
* @type {string}
|
|
5084
|
+
* @memberof Task
|
|
5085
|
+
*/
|
|
5086
|
+
'status': TaskStatusEnum;
|
|
5087
|
+
/**
|
|
5088
|
+
* Parent task id is the parent task that created this task
|
|
5089
|
+
* @type {string}
|
|
5090
|
+
* @memberof Task
|
|
5091
|
+
*/
|
|
5092
|
+
'parentTaskId'?: string;
|
|
5093
|
+
/**
|
|
5094
|
+
* Conversation id related to this task
|
|
5095
|
+
* @type {string}
|
|
5096
|
+
* @memberof Task
|
|
5097
|
+
*/
|
|
5098
|
+
'conversationId'?: string;
|
|
5099
|
+
/**
|
|
5100
|
+
* Specific user related to this task
|
|
5101
|
+
* @type {string}
|
|
5102
|
+
* @memberof Task
|
|
5103
|
+
*/
|
|
5104
|
+
'userId'?: string;
|
|
5105
|
+
/**
|
|
5106
|
+
* The timeout date where the task should be failed in the ISO 8601 format
|
|
5107
|
+
* @type {string}
|
|
5108
|
+
* @memberof Task
|
|
5109
|
+
*/
|
|
5110
|
+
'timeoutAt': string;
|
|
5111
|
+
/**
|
|
5112
|
+
* Creation date of the task in ISO 8601 format
|
|
5113
|
+
* @type {string}
|
|
5114
|
+
* @memberof Task
|
|
5115
|
+
*/
|
|
5116
|
+
'createdAt': string;
|
|
5117
|
+
/**
|
|
5118
|
+
* Updating date of the task in ISO 8601 format
|
|
5119
|
+
* @type {string}
|
|
5120
|
+
* @memberof Task
|
|
5121
|
+
*/
|
|
5122
|
+
'updatedAt': string;
|
|
5123
|
+
/**
|
|
5124
|
+
* If the task fails this is the reason behind it
|
|
5125
|
+
* @type {string}
|
|
5126
|
+
* @memberof Task
|
|
5127
|
+
*/
|
|
5128
|
+
'failureReason'?: string;
|
|
5129
|
+
/**
|
|
5130
|
+
* Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.
|
|
5131
|
+
* @type {{ [key: string]: string; }}
|
|
5132
|
+
* @memberof Task
|
|
5133
|
+
*/
|
|
5134
|
+
'tags': {
|
|
5135
|
+
[key: string]: string;
|
|
5136
|
+
};
|
|
5137
|
+
}
|
|
5138
|
+
export declare const TaskStatusEnum: {
|
|
5139
|
+
readonly Pending: "pending";
|
|
5140
|
+
readonly InProgress: "in_progress";
|
|
5141
|
+
readonly Failed: "failed";
|
|
5142
|
+
readonly Completed: "completed";
|
|
5143
|
+
readonly Blocked: "blocked";
|
|
5144
|
+
readonly Paused: "paused";
|
|
5145
|
+
};
|
|
5146
|
+
export type TaskStatusEnum = typeof TaskStatusEnum[keyof typeof TaskStatusEnum];
|
|
4394
5147
|
/**
|
|
4395
5148
|
*
|
|
4396
5149
|
* @export
|
|
@@ -4434,6 +5187,12 @@ export interface UpdateBotBody {
|
|
|
4434
5187
|
* @memberof UpdateBotBody
|
|
4435
5188
|
*/
|
|
4436
5189
|
'blocked'?: boolean;
|
|
5190
|
+
/**
|
|
5191
|
+
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
5192
|
+
* @type {boolean}
|
|
5193
|
+
* @memberof UpdateBotBody
|
|
5194
|
+
*/
|
|
5195
|
+
'alwaysAlive'?: boolean;
|
|
4437
5196
|
/**
|
|
4438
5197
|
*
|
|
4439
5198
|
* @type {UpdateBotBodyUser}
|
|
@@ -4484,6 +5243,12 @@ export interface UpdateBotBody {
|
|
|
4484
5243
|
'integrations'?: {
|
|
4485
5244
|
[key: string]: UpdateBotBodyIntegrationsValue | null;
|
|
4486
5245
|
};
|
|
5246
|
+
/**
|
|
5247
|
+
*
|
|
5248
|
+
* @type {UpdateBotBodySubscriptions}
|
|
5249
|
+
* @memberof UpdateBotBody
|
|
5250
|
+
*/
|
|
5251
|
+
'subscriptions'?: UpdateBotBodySubscriptions;
|
|
4487
5252
|
/**
|
|
4488
5253
|
* JavaScript code of the bot
|
|
4489
5254
|
* @type {string}
|
|
@@ -4502,12 +5267,6 @@ export interface UpdateBotBody {
|
|
|
4502
5267
|
* @memberof UpdateBotBody
|
|
4503
5268
|
*/
|
|
4504
5269
|
'medias'?: Array<CreateBotBodyMediasInner>;
|
|
4505
|
-
/**
|
|
4506
|
-
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
4507
|
-
* @type {boolean}
|
|
4508
|
-
* @memberof UpdateBotBody
|
|
4509
|
-
*/
|
|
4510
|
-
'alwaysAlive'?: boolean;
|
|
4511
5270
|
}
|
|
4512
5271
|
export declare const UpdateBotBodyAuthenticationEnum: {
|
|
4513
5272
|
readonly Iam: "iam";
|
|
@@ -4621,6 +5380,23 @@ export declare const UpdateBotBodyStatesValueTypeEnum: {
|
|
|
4621
5380
|
readonly Bot: "bot";
|
|
4622
5381
|
};
|
|
4623
5382
|
export type UpdateBotBodyStatesValueTypeEnum = typeof UpdateBotBodyStatesValueTypeEnum[keyof typeof UpdateBotBodyStatesValueTypeEnum];
|
|
5383
|
+
/**
|
|
5384
|
+
*
|
|
5385
|
+
* @export
|
|
5386
|
+
* @interface UpdateBotBodySubscriptions
|
|
5387
|
+
*/
|
|
5388
|
+
export interface UpdateBotBodySubscriptions {
|
|
5389
|
+
/**
|
|
5390
|
+
*
|
|
5391
|
+
* @type {{ [key: string]: { [key: string]: any; } | null; }}
|
|
5392
|
+
* @memberof UpdateBotBodySubscriptions
|
|
5393
|
+
*/
|
|
5394
|
+
'events': {
|
|
5395
|
+
[key: string]: {
|
|
5396
|
+
[key: string]: any;
|
|
5397
|
+
} | null;
|
|
5398
|
+
} | null;
|
|
5399
|
+
}
|
|
4624
5400
|
/**
|
|
4625
5401
|
*
|
|
4626
5402
|
* @export
|
|
@@ -4752,6 +5528,14 @@ export interface UpdateIntegrationBody {
|
|
|
4752
5528
|
* @memberof UpdateIntegrationBody
|
|
4753
5529
|
*/
|
|
4754
5530
|
'user'?: UpdateIntegrationBodyUser;
|
|
5531
|
+
/**
|
|
5532
|
+
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
5533
|
+
* @type {{ [key: string]: string | null; }}
|
|
5534
|
+
* @memberof UpdateIntegrationBody
|
|
5535
|
+
*/
|
|
5536
|
+
'secrets'?: {
|
|
5537
|
+
[key: string]: string | null;
|
|
5538
|
+
};
|
|
4755
5539
|
/**
|
|
4756
5540
|
* JavaScript code of the integration
|
|
4757
5541
|
* @type {string}
|
|
@@ -5043,6 +5827,75 @@ export interface UpdateMessageResponse {
|
|
|
5043
5827
|
*/
|
|
5044
5828
|
'message': Message;
|
|
5045
5829
|
}
|
|
5830
|
+
/**
|
|
5831
|
+
*
|
|
5832
|
+
* @export
|
|
5833
|
+
* @interface UpdateTaskBody
|
|
5834
|
+
*/
|
|
5835
|
+
export interface UpdateTaskBody {
|
|
5836
|
+
/**
|
|
5837
|
+
* Title describing the task
|
|
5838
|
+
* @type {string}
|
|
5839
|
+
* @memberof UpdateTaskBody
|
|
5840
|
+
*/
|
|
5841
|
+
'title'?: string;
|
|
5842
|
+
/**
|
|
5843
|
+
* All the notes related to the execution of the current task
|
|
5844
|
+
* @type {string}
|
|
5845
|
+
* @memberof UpdateTaskBody
|
|
5846
|
+
*/
|
|
5847
|
+
'instruction'?: string;
|
|
5848
|
+
/**
|
|
5849
|
+
* Content related to the task
|
|
5850
|
+
* @type {{ [key: string]: any; }}
|
|
5851
|
+
* @memberof UpdateTaskBody
|
|
5852
|
+
*/
|
|
5853
|
+
'data'?: {
|
|
5854
|
+
[key: string]: any;
|
|
5855
|
+
};
|
|
5856
|
+
/**
|
|
5857
|
+
* The timeout date where the task should be failed in the ISO 8601 format
|
|
5858
|
+
* @type {string}
|
|
5859
|
+
* @memberof UpdateTaskBody
|
|
5860
|
+
*/
|
|
5861
|
+
'timeoutAt'?: string;
|
|
5862
|
+
/**
|
|
5863
|
+
* Status of the task
|
|
5864
|
+
* @type {string}
|
|
5865
|
+
* @memberof UpdateTaskBody
|
|
5866
|
+
*/
|
|
5867
|
+
'status'?: UpdateTaskBodyStatusEnum;
|
|
5868
|
+
/**
|
|
5869
|
+
* Tags for the [Task](#schema_task)
|
|
5870
|
+
* @type {{ [key: string]: string; }}
|
|
5871
|
+
* @memberof UpdateTaskBody
|
|
5872
|
+
*/
|
|
5873
|
+
'tags'?: {
|
|
5874
|
+
[key: string]: string;
|
|
5875
|
+
};
|
|
5876
|
+
}
|
|
5877
|
+
export declare const UpdateTaskBodyStatusEnum: {
|
|
5878
|
+
readonly Pending: "pending";
|
|
5879
|
+
readonly InProgress: "in_progress";
|
|
5880
|
+
readonly Failed: "failed";
|
|
5881
|
+
readonly Completed: "completed";
|
|
5882
|
+
readonly Blocked: "blocked";
|
|
5883
|
+
readonly Paused: "paused";
|
|
5884
|
+
};
|
|
5885
|
+
export type UpdateTaskBodyStatusEnum = typeof UpdateTaskBodyStatusEnum[keyof typeof UpdateTaskBodyStatusEnum];
|
|
5886
|
+
/**
|
|
5887
|
+
*
|
|
5888
|
+
* @export
|
|
5889
|
+
* @interface UpdateTaskResponse
|
|
5890
|
+
*/
|
|
5891
|
+
export interface UpdateTaskResponse {
|
|
5892
|
+
/**
|
|
5893
|
+
*
|
|
5894
|
+
* @type {Task}
|
|
5895
|
+
* @memberof UpdateTaskResponse
|
|
5896
|
+
*/
|
|
5897
|
+
'task': Task;
|
|
5898
|
+
}
|
|
5046
5899
|
/**
|
|
5047
5900
|
*
|
|
5048
5901
|
* @export
|
|
@@ -5101,6 +5954,48 @@ export interface UpdateWorkspaceBody {
|
|
|
5101
5954
|
* @memberof UpdateWorkspaceBody
|
|
5102
5955
|
*/
|
|
5103
5956
|
'spendingLimit'?: number;
|
|
5957
|
+
/**
|
|
5958
|
+
*
|
|
5959
|
+
* @type {string}
|
|
5960
|
+
* @memberof UpdateWorkspaceBody
|
|
5961
|
+
*/
|
|
5962
|
+
'about'?: string;
|
|
5963
|
+
/**
|
|
5964
|
+
*
|
|
5965
|
+
* @type {string}
|
|
5966
|
+
* @memberof UpdateWorkspaceBody
|
|
5967
|
+
*/
|
|
5968
|
+
'profilePicture'?: string;
|
|
5969
|
+
/**
|
|
5970
|
+
*
|
|
5971
|
+
* @type {string}
|
|
5972
|
+
* @memberof UpdateWorkspaceBody
|
|
5973
|
+
*/
|
|
5974
|
+
'contactEmail'?: string;
|
|
5975
|
+
/**
|
|
5976
|
+
*
|
|
5977
|
+
* @type {string}
|
|
5978
|
+
* @memberof UpdateWorkspaceBody
|
|
5979
|
+
*/
|
|
5980
|
+
'website'?: string;
|
|
5981
|
+
/**
|
|
5982
|
+
*
|
|
5983
|
+
* @type {Array<string>}
|
|
5984
|
+
* @memberof UpdateWorkspaceBody
|
|
5985
|
+
*/
|
|
5986
|
+
'socialAccounts'?: Array<string>;
|
|
5987
|
+
/**
|
|
5988
|
+
*
|
|
5989
|
+
* @type {boolean}
|
|
5990
|
+
* @memberof UpdateWorkspaceBody
|
|
5991
|
+
*/
|
|
5992
|
+
'isPublic'?: boolean;
|
|
5993
|
+
/**
|
|
5994
|
+
*
|
|
5995
|
+
* @type {string}
|
|
5996
|
+
* @memberof UpdateWorkspaceBody
|
|
5997
|
+
*/
|
|
5998
|
+
'handle'?: string;
|
|
5104
5999
|
}
|
|
5105
6000
|
/**
|
|
5106
6001
|
*
|
|
@@ -5148,6 +6043,12 @@ export interface UpdateWorkspaceMemberResponse {
|
|
|
5148
6043
|
* @memberof UpdateWorkspaceMemberResponse
|
|
5149
6044
|
*/
|
|
5150
6045
|
'email': string;
|
|
6046
|
+
/**
|
|
6047
|
+
*
|
|
6048
|
+
* @type {string}
|
|
6049
|
+
* @memberof UpdateWorkspaceMemberResponse
|
|
6050
|
+
*/
|
|
6051
|
+
'createdAt': string;
|
|
5151
6052
|
/**
|
|
5152
6053
|
*
|
|
5153
6054
|
* @type {string}
|
|
@@ -5236,6 +6137,48 @@ export interface UpdateWorkspaceResponse {
|
|
|
5236
6137
|
* @memberof UpdateWorkspaceResponse
|
|
5237
6138
|
*/
|
|
5238
6139
|
'spendingLimit': number;
|
|
6140
|
+
/**
|
|
6141
|
+
*
|
|
6142
|
+
* @type {string}
|
|
6143
|
+
* @memberof UpdateWorkspaceResponse
|
|
6144
|
+
*/
|
|
6145
|
+
'about'?: string;
|
|
6146
|
+
/**
|
|
6147
|
+
*
|
|
6148
|
+
* @type {string}
|
|
6149
|
+
* @memberof UpdateWorkspaceResponse
|
|
6150
|
+
*/
|
|
6151
|
+
'profilePicture'?: string;
|
|
6152
|
+
/**
|
|
6153
|
+
*
|
|
6154
|
+
* @type {string}
|
|
6155
|
+
* @memberof UpdateWorkspaceResponse
|
|
6156
|
+
*/
|
|
6157
|
+
'contactEmail'?: string;
|
|
6158
|
+
/**
|
|
6159
|
+
*
|
|
6160
|
+
* @type {string}
|
|
6161
|
+
* @memberof UpdateWorkspaceResponse
|
|
6162
|
+
*/
|
|
6163
|
+
'website'?: string;
|
|
6164
|
+
/**
|
|
6165
|
+
*
|
|
6166
|
+
* @type {Array<string>}
|
|
6167
|
+
* @memberof UpdateWorkspaceResponse
|
|
6168
|
+
*/
|
|
6169
|
+
'socialAccounts'?: Array<string>;
|
|
6170
|
+
/**
|
|
6171
|
+
*
|
|
6172
|
+
* @type {boolean}
|
|
6173
|
+
* @memberof UpdateWorkspaceResponse
|
|
6174
|
+
*/
|
|
6175
|
+
'isPublic'?: boolean;
|
|
6176
|
+
/**
|
|
6177
|
+
*
|
|
6178
|
+
* @type {string}
|
|
6179
|
+
* @memberof UpdateWorkspaceResponse
|
|
6180
|
+
*/
|
|
6181
|
+
'handle'?: string;
|
|
5239
6182
|
}
|
|
5240
6183
|
export declare const UpdateWorkspaceResponseAccountTypeEnum: {
|
|
5241
6184
|
readonly Free: "free";
|
|
@@ -5325,6 +6268,48 @@ export interface UpdateWorkspaceResponse1 {
|
|
|
5325
6268
|
* @memberof UpdateWorkspaceResponse1
|
|
5326
6269
|
*/
|
|
5327
6270
|
'spendingLimit': number;
|
|
6271
|
+
/**
|
|
6272
|
+
*
|
|
6273
|
+
* @type {string}
|
|
6274
|
+
* @memberof UpdateWorkspaceResponse1
|
|
6275
|
+
*/
|
|
6276
|
+
'about'?: string;
|
|
6277
|
+
/**
|
|
6278
|
+
*
|
|
6279
|
+
* @type {string}
|
|
6280
|
+
* @memberof UpdateWorkspaceResponse1
|
|
6281
|
+
*/
|
|
6282
|
+
'profilePicture'?: string;
|
|
6283
|
+
/**
|
|
6284
|
+
*
|
|
6285
|
+
* @type {string}
|
|
6286
|
+
* @memberof UpdateWorkspaceResponse1
|
|
6287
|
+
*/
|
|
6288
|
+
'contactEmail'?: string;
|
|
6289
|
+
/**
|
|
6290
|
+
*
|
|
6291
|
+
* @type {string}
|
|
6292
|
+
* @memberof UpdateWorkspaceResponse1
|
|
6293
|
+
*/
|
|
6294
|
+
'website'?: string;
|
|
6295
|
+
/**
|
|
6296
|
+
*
|
|
6297
|
+
* @type {Array<string>}
|
|
6298
|
+
* @memberof UpdateWorkspaceResponse1
|
|
6299
|
+
*/
|
|
6300
|
+
'socialAccounts'?: Array<string>;
|
|
6301
|
+
/**
|
|
6302
|
+
*
|
|
6303
|
+
* @type {boolean}
|
|
6304
|
+
* @memberof UpdateWorkspaceResponse1
|
|
6305
|
+
*/
|
|
6306
|
+
'isPublic'?: boolean;
|
|
6307
|
+
/**
|
|
6308
|
+
*
|
|
6309
|
+
* @type {string}
|
|
6310
|
+
* @memberof UpdateWorkspaceResponse1
|
|
6311
|
+
*/
|
|
6312
|
+
'handle'?: string;
|
|
5328
6313
|
}
|
|
5329
6314
|
export declare const UpdateWorkspaceResponse1AccountTypeEnum: {
|
|
5330
6315
|
readonly Free: "free";
|
|
@@ -5475,43 +6460,85 @@ export interface Workspace {
|
|
|
5475
6460
|
* @type {string}
|
|
5476
6461
|
* @memberof Workspace
|
|
5477
6462
|
*/
|
|
5478
|
-
'updatedAt': string;
|
|
6463
|
+
'updatedAt': string;
|
|
6464
|
+
/**
|
|
6465
|
+
*
|
|
6466
|
+
* @type {number}
|
|
6467
|
+
* @memberof Workspace
|
|
6468
|
+
*/
|
|
6469
|
+
'botCount': number;
|
|
6470
|
+
/**
|
|
6471
|
+
*
|
|
6472
|
+
* @type {string}
|
|
6473
|
+
* @memberof Workspace
|
|
6474
|
+
*/
|
|
6475
|
+
'accountType': WorkspaceAccountTypeEnum;
|
|
6476
|
+
/**
|
|
6477
|
+
*
|
|
6478
|
+
* @type {string}
|
|
6479
|
+
* @memberof Workspace
|
|
6480
|
+
*/
|
|
6481
|
+
'billingVersion': WorkspaceBillingVersionEnum;
|
|
6482
|
+
/**
|
|
6483
|
+
*
|
|
6484
|
+
* @type {string}
|
|
6485
|
+
* @memberof Workspace
|
|
6486
|
+
*/
|
|
6487
|
+
'plan': WorkspacePlanEnum;
|
|
6488
|
+
/**
|
|
6489
|
+
*
|
|
6490
|
+
* @type {boolean}
|
|
6491
|
+
* @memberof Workspace
|
|
6492
|
+
*/
|
|
6493
|
+
'blocked': boolean;
|
|
6494
|
+
/**
|
|
6495
|
+
*
|
|
6496
|
+
* @type {number}
|
|
6497
|
+
* @memberof Workspace
|
|
6498
|
+
*/
|
|
6499
|
+
'spendingLimit': number;
|
|
6500
|
+
/**
|
|
6501
|
+
*
|
|
6502
|
+
* @type {string}
|
|
6503
|
+
* @memberof Workspace
|
|
6504
|
+
*/
|
|
6505
|
+
'about'?: string;
|
|
5479
6506
|
/**
|
|
5480
6507
|
*
|
|
5481
|
-
* @type {
|
|
6508
|
+
* @type {string}
|
|
5482
6509
|
* @memberof Workspace
|
|
5483
6510
|
*/
|
|
5484
|
-
'
|
|
6511
|
+
'profilePicture'?: string;
|
|
5485
6512
|
/**
|
|
5486
6513
|
*
|
|
5487
6514
|
* @type {string}
|
|
5488
6515
|
* @memberof Workspace
|
|
5489
6516
|
*/
|
|
5490
|
-
'
|
|
6517
|
+
'contactEmail'?: string;
|
|
5491
6518
|
/**
|
|
5492
6519
|
*
|
|
5493
6520
|
* @type {string}
|
|
5494
6521
|
* @memberof Workspace
|
|
5495
6522
|
*/
|
|
5496
|
-
'
|
|
6523
|
+
'website'?: string;
|
|
5497
6524
|
/**
|
|
5498
6525
|
*
|
|
5499
|
-
* @type {string}
|
|
6526
|
+
* @type {Array<string>}
|
|
5500
6527
|
* @memberof Workspace
|
|
5501
6528
|
*/
|
|
5502
|
-
'
|
|
6529
|
+
'socialAccounts'?: Array<string>;
|
|
5503
6530
|
/**
|
|
5504
6531
|
*
|
|
5505
6532
|
* @type {boolean}
|
|
5506
6533
|
* @memberof Workspace
|
|
5507
6534
|
*/
|
|
5508
|
-
'
|
|
6535
|
+
'isPublic'?: boolean;
|
|
5509
6536
|
/**
|
|
5510
6537
|
*
|
|
5511
|
-
* @type {
|
|
6538
|
+
* @type {string}
|
|
5512
6539
|
* @memberof Workspace
|
|
5513
6540
|
*/
|
|
5514
|
-
'
|
|
6541
|
+
'handle'?: string;
|
|
5515
6542
|
}
|
|
5516
6543
|
export declare const WorkspaceAccountTypeEnum: {
|
|
5517
6544
|
readonly Free: "free";
|
|
@@ -5553,6 +6580,12 @@ export interface WorkspaceMember {
|
|
|
5553
6580
|
* @memberof WorkspaceMember
|
|
5554
6581
|
*/
|
|
5555
6582
|
'email': string;
|
|
6583
|
+
/**
|
|
6584
|
+
*
|
|
6585
|
+
* @type {string}
|
|
6586
|
+
* @memberof WorkspaceMember
|
|
6587
|
+
*/
|
|
6588
|
+
'createdAt': string;
|
|
5556
6589
|
/**
|
|
5557
6590
|
*
|
|
5558
6591
|
* @type {string}
|
|
@@ -5621,6 +6654,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5621
6654
|
* @throws {RequiredError}
|
|
5622
6655
|
*/
|
|
5623
6656
|
chargeWorkspaceUnpaidInvoices: (id: string, chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6657
|
+
/**
|
|
6658
|
+
* Check if a workspace handle is available
|
|
6659
|
+
* @param {CheckHandleAvailabilityBody} [checkHandleAvailabilityBody] Workspace handle availability
|
|
6660
|
+
* @param {*} [options] Override http request option.
|
|
6661
|
+
* @throws {RequiredError}
|
|
6662
|
+
*/
|
|
6663
|
+
checkHandleAvailability: (checkHandleAvailabilityBody?: CheckHandleAvailabilityBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5624
6664
|
/**
|
|
5625
6665
|
* An integration can call this endpoint to configure itself
|
|
5626
6666
|
* @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
|
|
@@ -5677,6 +6717,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5677
6717
|
* @throws {RequiredError}
|
|
5678
6718
|
*/
|
|
5679
6719
|
createPersonalAccessToken: (createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6720
|
+
/**
|
|
6721
|
+
* Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.
|
|
6722
|
+
* @param {CreateTaskBody} [createTaskBody] Task data
|
|
6723
|
+
* @param {*} [options] Override http request option.
|
|
6724
|
+
* @throws {RequiredError}
|
|
6725
|
+
*/
|
|
6726
|
+
createTask: (createTaskBody?: CreateTaskBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5680
6727
|
/**
|
|
5681
6728
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
5682
6729
|
* @param {CreateUserBody} [createUserBody] User data
|
|
@@ -5748,6 +6795,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5748
6795
|
* @throws {RequiredError}
|
|
5749
6796
|
*/
|
|
5750
6797
|
deletePersonalAccessToken: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6798
|
+
/**
|
|
6799
|
+
* Permanently deletes a [Task](#schema_task). It cannot be undone.
|
|
6800
|
+
* @param {string} id Task id
|
|
6801
|
+
* @param {*} [options] Override http request option.
|
|
6802
|
+
* @throws {RequiredError}
|
|
6803
|
+
*/
|
|
6804
|
+
deleteTask: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5751
6805
|
/**
|
|
5752
6806
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
5753
6807
|
* @param {string} id User ID
|
|
@@ -5782,6 +6836,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5782
6836
|
* @throws {RequiredError}
|
|
5783
6837
|
*/
|
|
5784
6838
|
getAccount: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6839
|
+
/**
|
|
6840
|
+
* Get a preference of the account
|
|
6841
|
+
* @param {string} key Preference key
|
|
6842
|
+
* @param {*} [options] Override http request option.
|
|
6843
|
+
* @throws {RequiredError}
|
|
6844
|
+
*/
|
|
6845
|
+
getAccountPreference: (key: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5785
6846
|
/**
|
|
5786
6847
|
* For a user, gets a map of workspace IDs to their highest quota completion rate
|
|
5787
6848
|
* @param {*} [options] Override http request option.
|
|
@@ -5936,6 +6997,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
5936
6997
|
* @throws {RequiredError}
|
|
5937
6998
|
*/
|
|
5938
6999
|
getState: (type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7000
|
+
/**
|
|
7001
|
+
* Retrieves the [Task](#schema_task) object for a valid identifier.
|
|
7002
|
+
* @param {string} id Task id
|
|
7003
|
+
* @param {*} [options] Override http request option.
|
|
7004
|
+
* @throws {RequiredError}
|
|
7005
|
+
*/
|
|
7006
|
+
getTask: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5939
7007
|
/**
|
|
5940
7008
|
* Get usage
|
|
5941
7009
|
* @param {GetUsageTypeEnum} type Type of usage
|
|
@@ -6018,7 +7086,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6018
7086
|
[key: string]: string;
|
|
6019
7087
|
} | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6020
7088
|
/**
|
|
6021
|
-
*
|
|
7089
|
+
* Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
6022
7090
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
6023
7091
|
* @param {string} [type] Filter by event type
|
|
6024
7092
|
* @param {string} [conversationId] Filter by conversation id
|
|
@@ -6080,6 +7148,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6080
7148
|
* @throws {RequiredError}
|
|
6081
7149
|
*/
|
|
6082
7150
|
listPublicIntegrations: (nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7151
|
+
/**
|
|
7152
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
7153
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
7154
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
7155
|
+
* @param {string} [conversationId] Conversation id
|
|
7156
|
+
* @param {string} [userId] User id
|
|
7157
|
+
* @param {string} [parentTaskId] Parent task id
|
|
7158
|
+
* @param {ListTasksStatusEnum} [status] Status
|
|
7159
|
+
* @param {string} [type] Type
|
|
7160
|
+
* @param {*} [options] Override http request option.
|
|
7161
|
+
* @throws {RequiredError}
|
|
7162
|
+
*/
|
|
7163
|
+
listTasks: (nextToken?: string, tags?: {
|
|
7164
|
+
[key: string]: string;
|
|
7165
|
+
} | undefined, conversationId?: string, userId?: string, parentTaskId?: string, status?: ListTasksStatusEnum, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6083
7166
|
/**
|
|
6084
7167
|
* Get usage history
|
|
6085
7168
|
* @param {ListUsageHistoryTypeEnum} type Type of usage
|
|
@@ -6162,6 +7245,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6162
7245
|
* @throws {RequiredError}
|
|
6163
7246
|
*/
|
|
6164
7247
|
runVrl: (runVrlBody?: RunVrlBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7248
|
+
/**
|
|
7249
|
+
* Set a preference for the account
|
|
7250
|
+
* @param {string} key Preference key
|
|
7251
|
+
* @param {SetAccountPreferenceBody} [setAccountPreferenceBody] Preference value
|
|
7252
|
+
* @param {*} [options] Override http request option.
|
|
7253
|
+
* @throws {RequiredError}
|
|
7254
|
+
*/
|
|
7255
|
+
setAccountPreference: (key: string, setAccountPreferenceBody?: SetAccountPreferenceBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6165
7256
|
/**
|
|
6166
7257
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
6167
7258
|
* @param {SetStateTypeEnum} type State type
|
|
@@ -6220,6 +7311,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
6220
7311
|
* @throws {RequiredError}
|
|
6221
7312
|
*/
|
|
6222
7313
|
updateMessage: (id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7314
|
+
/**
|
|
7315
|
+
* Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
7316
|
+
* @param {string} id Task id
|
|
7317
|
+
* @param {UpdateTaskBody} [updateTaskBody] Task data
|
|
7318
|
+
* @param {*} [options] Override http request option.
|
|
7319
|
+
* @throws {RequiredError}
|
|
7320
|
+
*/
|
|
7321
|
+
updateTask: (id: string, updateTaskBody?: UpdateTaskBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6223
7322
|
/**
|
|
6224
7323
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
6225
7324
|
* @param {string} id User ID
|
|
@@ -6297,6 +7396,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6297
7396
|
* @throws {RequiredError}
|
|
6298
7397
|
*/
|
|
6299
7398
|
chargeWorkspaceUnpaidInvoices(id: string, chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChargeWorkspaceUnpaidInvoicesResponse>>;
|
|
7399
|
+
/**
|
|
7400
|
+
* Check if a workspace handle is available
|
|
7401
|
+
* @param {CheckHandleAvailabilityBody} [checkHandleAvailabilityBody] Workspace handle availability
|
|
7402
|
+
* @param {*} [options] Override http request option.
|
|
7403
|
+
* @throws {RequiredError}
|
|
7404
|
+
*/
|
|
7405
|
+
checkHandleAvailability(checkHandleAvailabilityBody?: CheckHandleAvailabilityBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CheckHandleAvailabilityResponse>>;
|
|
6300
7406
|
/**
|
|
6301
7407
|
* An integration can call this endpoint to configure itself
|
|
6302
7408
|
* @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
|
|
@@ -6353,6 +7459,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6353
7459
|
* @throws {RequiredError}
|
|
6354
7460
|
*/
|
|
6355
7461
|
createPersonalAccessToken(createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePersonalAccessTokenResponse>>;
|
|
7462
|
+
/**
|
|
7463
|
+
* Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.
|
|
7464
|
+
* @param {CreateTaskBody} [createTaskBody] Task data
|
|
7465
|
+
* @param {*} [options] Override http request option.
|
|
7466
|
+
* @throws {RequiredError}
|
|
7467
|
+
*/
|
|
7468
|
+
createTask(createTaskBody?: CreateTaskBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTaskResponse>>;
|
|
6356
7469
|
/**
|
|
6357
7470
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
6358
7471
|
* @param {CreateUserBody} [createUserBody] User data
|
|
@@ -6424,6 +7537,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6424
7537
|
* @throws {RequiredError}
|
|
6425
7538
|
*/
|
|
6426
7539
|
deletePersonalAccessToken(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
7540
|
+
/**
|
|
7541
|
+
* Permanently deletes a [Task](#schema_task). It cannot be undone.
|
|
7542
|
+
* @param {string} id Task id
|
|
7543
|
+
* @param {*} [options] Override http request option.
|
|
7544
|
+
* @throws {RequiredError}
|
|
7545
|
+
*/
|
|
7546
|
+
deleteTask(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
6427
7547
|
/**
|
|
6428
7548
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
6429
7549
|
* @param {string} id User ID
|
|
@@ -6458,6 +7578,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6458
7578
|
* @throws {RequiredError}
|
|
6459
7579
|
*/
|
|
6460
7580
|
getAccount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountResponse>>;
|
|
7581
|
+
/**
|
|
7582
|
+
* Get a preference of the account
|
|
7583
|
+
* @param {string} key Preference key
|
|
7584
|
+
* @param {*} [options] Override http request option.
|
|
7585
|
+
* @throws {RequiredError}
|
|
7586
|
+
*/
|
|
7587
|
+
getAccountPreference(key: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountPreferenceResponse>>;
|
|
6461
7588
|
/**
|
|
6462
7589
|
* For a user, gets a map of workspace IDs to their highest quota completion rate
|
|
6463
7590
|
* @param {*} [options] Override http request option.
|
|
@@ -6614,6 +7741,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6614
7741
|
* @throws {RequiredError}
|
|
6615
7742
|
*/
|
|
6616
7743
|
getState(type: GetStateTypeEnum, id: string, name: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStateResponse>>;
|
|
7744
|
+
/**
|
|
7745
|
+
* Retrieves the [Task](#schema_task) object for a valid identifier.
|
|
7746
|
+
* @param {string} id Task id
|
|
7747
|
+
* @param {*} [options] Override http request option.
|
|
7748
|
+
* @throws {RequiredError}
|
|
7749
|
+
*/
|
|
7750
|
+
getTask(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaskResponse>>;
|
|
6617
7751
|
/**
|
|
6618
7752
|
* Get usage
|
|
6619
7753
|
* @param {GetUsageTypeEnum} type Type of usage
|
|
@@ -6696,7 +7830,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6696
7830
|
[key: string]: string;
|
|
6697
7831
|
} | undefined, participantIds?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversationsResponse>>;
|
|
6698
7832
|
/**
|
|
6699
|
-
*
|
|
7833
|
+
* Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
6700
7834
|
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
6701
7835
|
* @param {string} [type] Filter by event type
|
|
6702
7836
|
* @param {string} [conversationId] Filter by conversation id
|
|
@@ -6758,6 +7892,21 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6758
7892
|
* @throws {RequiredError}
|
|
6759
7893
|
*/
|
|
6760
7894
|
listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPublicIntegrationsResponse>>;
|
|
7895
|
+
/**
|
|
7896
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
7897
|
+
* @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
7898
|
+
* @param {{ [key: string]: string; }} [tags] Filter by tags
|
|
7899
|
+
* @param {string} [conversationId] Conversation id
|
|
7900
|
+
* @param {string} [userId] User id
|
|
7901
|
+
* @param {string} [parentTaskId] Parent task id
|
|
7902
|
+
* @param {ListTasksStatusEnum} [status] Status
|
|
7903
|
+
* @param {string} [type] Type
|
|
7904
|
+
* @param {*} [options] Override http request option.
|
|
7905
|
+
* @throws {RequiredError}
|
|
7906
|
+
*/
|
|
7907
|
+
listTasks(nextToken?: string, tags?: {
|
|
7908
|
+
[key: string]: string;
|
|
7909
|
+
} | undefined, conversationId?: string, userId?: string, parentTaskId?: string, status?: ListTasksStatusEnum, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponse>>;
|
|
6761
7910
|
/**
|
|
6762
7911
|
* Get usage history
|
|
6763
7912
|
* @param {ListUsageHistoryTypeEnum} type Type of usage
|
|
@@ -6840,6 +7989,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6840
7989
|
* @throws {RequiredError}
|
|
6841
7990
|
*/
|
|
6842
7991
|
runVrl(runVrlBody?: RunVrlBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RunVrlResponse>>;
|
|
7992
|
+
/**
|
|
7993
|
+
* Set a preference for the account
|
|
7994
|
+
* @param {string} key Preference key
|
|
7995
|
+
* @param {SetAccountPreferenceBody} [setAccountPreferenceBody] Preference value
|
|
7996
|
+
* @param {*} [options] Override http request option.
|
|
7997
|
+
* @throws {RequiredError}
|
|
7998
|
+
*/
|
|
7999
|
+
setAccountPreference(key: string, setAccountPreferenceBody?: SetAccountPreferenceBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
6843
8000
|
/**
|
|
6844
8001
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
6845
8002
|
* @param {SetStateTypeEnum} type State type
|
|
@@ -6898,6 +8055,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
6898
8055
|
* @throws {RequiredError}
|
|
6899
8056
|
*/
|
|
6900
8057
|
updateMessage(id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateMessageResponse>>;
|
|
8058
|
+
/**
|
|
8059
|
+
* Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
8060
|
+
* @param {string} id Task id
|
|
8061
|
+
* @param {UpdateTaskBody} [updateTaskBody] Task data
|
|
8062
|
+
* @param {*} [options] Override http request option.
|
|
8063
|
+
* @throws {RequiredError}
|
|
8064
|
+
*/
|
|
8065
|
+
updateTask(id: string, updateTaskBody?: UpdateTaskBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTaskResponse>>;
|
|
6901
8066
|
/**
|
|
6902
8067
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
6903
8068
|
* @param {string} id User ID
|
|
@@ -6970,6 +8135,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
6970
8135
|
* @throws {RequiredError}
|
|
6971
8136
|
*/
|
|
6972
8137
|
chargeWorkspaceUnpaidInvoices(requestParameters: DefaultApiChargeWorkspaceUnpaidInvoicesRequest, options?: AxiosRequestConfig): AxiosPromise<ChargeWorkspaceUnpaidInvoicesResponse>;
|
|
8138
|
+
/**
|
|
8139
|
+
* Check if a workspace handle is available
|
|
8140
|
+
* @param {DefaultApiCheckHandleAvailabilityRequest} requestParameters Request parameters.
|
|
8141
|
+
* @param {*} [options] Override http request option.
|
|
8142
|
+
* @throws {RequiredError}
|
|
8143
|
+
*/
|
|
8144
|
+
checkHandleAvailability(requestParameters?: DefaultApiCheckHandleAvailabilityRequest, options?: AxiosRequestConfig): AxiosPromise<CheckHandleAvailabilityResponse>;
|
|
6973
8145
|
/**
|
|
6974
8146
|
* An integration can call this endpoint to configure itself
|
|
6975
8147
|
* @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
|
|
@@ -7026,6 +8198,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7026
8198
|
* @throws {RequiredError}
|
|
7027
8199
|
*/
|
|
7028
8200
|
createPersonalAccessToken(requestParameters?: DefaultApiCreatePersonalAccessTokenRequest, options?: AxiosRequestConfig): AxiosPromise<CreatePersonalAccessTokenResponse>;
|
|
8201
|
+
/**
|
|
8202
|
+
* Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.
|
|
8203
|
+
* @param {DefaultApiCreateTaskRequest} requestParameters Request parameters.
|
|
8204
|
+
* @param {*} [options] Override http request option.
|
|
8205
|
+
* @throws {RequiredError}
|
|
8206
|
+
*/
|
|
8207
|
+
createTask(requestParameters?: DefaultApiCreateTaskRequest, options?: AxiosRequestConfig): AxiosPromise<CreateTaskResponse>;
|
|
7029
8208
|
/**
|
|
7030
8209
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
7031
8210
|
* @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
|
|
@@ -7096,6 +8275,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7096
8275
|
* @throws {RequiredError}
|
|
7097
8276
|
*/
|
|
7098
8277
|
deletePersonalAccessToken(requestParameters: DefaultApiDeletePersonalAccessTokenRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
8278
|
+
/**
|
|
8279
|
+
* Permanently deletes a [Task](#schema_task). It cannot be undone.
|
|
8280
|
+
* @param {DefaultApiDeleteTaskRequest} requestParameters Request parameters.
|
|
8281
|
+
* @param {*} [options] Override http request option.
|
|
8282
|
+
* @throws {RequiredError}
|
|
8283
|
+
*/
|
|
8284
|
+
deleteTask(requestParameters: DefaultApiDeleteTaskRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
7099
8285
|
/**
|
|
7100
8286
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
7101
8287
|
* @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
|
|
@@ -7130,6 +8316,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7130
8316
|
* @throws {RequiredError}
|
|
7131
8317
|
*/
|
|
7132
8318
|
getAccount(options?: AxiosRequestConfig): AxiosPromise<GetAccountResponse>;
|
|
8319
|
+
/**
|
|
8320
|
+
* Get a preference of the account
|
|
8321
|
+
* @param {DefaultApiGetAccountPreferenceRequest} requestParameters Request parameters.
|
|
8322
|
+
* @param {*} [options] Override http request option.
|
|
8323
|
+
* @throws {RequiredError}
|
|
8324
|
+
*/
|
|
8325
|
+
getAccountPreference(requestParameters: DefaultApiGetAccountPreferenceRequest, options?: AxiosRequestConfig): AxiosPromise<GetAccountPreferenceResponse>;
|
|
7133
8326
|
/**
|
|
7134
8327
|
* For a user, gets a map of workspace IDs to their highest quota completion rate
|
|
7135
8328
|
* @param {*} [options] Override http request option.
|
|
@@ -7271,6 +8464,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7271
8464
|
* @throws {RequiredError}
|
|
7272
8465
|
*/
|
|
7273
8466
|
getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): AxiosPromise<GetStateResponse>;
|
|
8467
|
+
/**
|
|
8468
|
+
* Retrieves the [Task](#schema_task) object for a valid identifier.
|
|
8469
|
+
* @param {DefaultApiGetTaskRequest} requestParameters Request parameters.
|
|
8470
|
+
* @param {*} [options] Override http request option.
|
|
8471
|
+
* @throws {RequiredError}
|
|
8472
|
+
*/
|
|
8473
|
+
getTask(requestParameters: DefaultApiGetTaskRequest, options?: AxiosRequestConfig): AxiosPromise<GetTaskResponse>;
|
|
7274
8474
|
/**
|
|
7275
8475
|
* Get usage
|
|
7276
8476
|
* @param {DefaultApiGetUsageRequest} requestParameters Request parameters.
|
|
@@ -7342,7 +8542,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7342
8542
|
*/
|
|
7343
8543
|
listConversations(requestParameters?: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
|
|
7344
8544
|
/**
|
|
7345
|
-
*
|
|
8545
|
+
* Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
7346
8546
|
* @param {DefaultApiListEventsRequest} requestParameters Request parameters.
|
|
7347
8547
|
* @param {*} [options] Override http request option.
|
|
7348
8548
|
* @throws {RequiredError}
|
|
@@ -7389,6 +8589,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7389
8589
|
* @throws {RequiredError}
|
|
7390
8590
|
*/
|
|
7391
8591
|
listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPublicIntegrationsResponse>;
|
|
8592
|
+
/**
|
|
8593
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
8594
|
+
* @param {DefaultApiListTasksRequest} requestParameters Request parameters.
|
|
8595
|
+
* @param {*} [options] Override http request option.
|
|
8596
|
+
* @throws {RequiredError}
|
|
8597
|
+
*/
|
|
8598
|
+
listTasks(requestParameters?: DefaultApiListTasksRequest, options?: AxiosRequestConfig): AxiosPromise<ListTasksResponse>;
|
|
7392
8599
|
/**
|
|
7393
8600
|
* Get usage history
|
|
7394
8601
|
* @param {DefaultApiListUsageHistoryRequest} requestParameters Request parameters.
|
|
@@ -7459,6 +8666,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7459
8666
|
* @throws {RequiredError}
|
|
7460
8667
|
*/
|
|
7461
8668
|
runVrl(requestParameters?: DefaultApiRunVrlRequest, options?: AxiosRequestConfig): AxiosPromise<RunVrlResponse>;
|
|
8669
|
+
/**
|
|
8670
|
+
* Set a preference for the account
|
|
8671
|
+
* @param {DefaultApiSetAccountPreferenceRequest} requestParameters Request parameters.
|
|
8672
|
+
* @param {*} [options] Override http request option.
|
|
8673
|
+
* @throws {RequiredError}
|
|
8674
|
+
*/
|
|
8675
|
+
setAccountPreference(requestParameters: DefaultApiSetAccountPreferenceRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
|
|
7462
8676
|
/**
|
|
7463
8677
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
7464
8678
|
* @param {DefaultApiSetStateRequest} requestParameters Request parameters.
|
|
@@ -7508,6 +8722,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
7508
8722
|
* @throws {RequiredError}
|
|
7509
8723
|
*/
|
|
7510
8724
|
updateMessage(requestParameters: DefaultApiUpdateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateMessageResponse>;
|
|
8725
|
+
/**
|
|
8726
|
+
* Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
8727
|
+
* @param {DefaultApiUpdateTaskRequest} requestParameters Request parameters.
|
|
8728
|
+
* @param {*} [options] Override http request option.
|
|
8729
|
+
* @throws {RequiredError}
|
|
8730
|
+
*/
|
|
8731
|
+
updateTask(requestParameters: DefaultApiUpdateTaskRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateTaskResponse>;
|
|
7511
8732
|
/**
|
|
7512
8733
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
7513
8734
|
* @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
|
|
@@ -7638,6 +8859,19 @@ export interface DefaultApiChargeWorkspaceUnpaidInvoicesRequest {
|
|
|
7638
8859
|
*/
|
|
7639
8860
|
readonly chargeWorkspaceUnpaidInvoicesBody?: ChargeWorkspaceUnpaidInvoicesBody;
|
|
7640
8861
|
}
|
|
8862
|
+
/**
|
|
8863
|
+
* Request parameters for checkHandleAvailability operation in DefaultApi.
|
|
8864
|
+
* @export
|
|
8865
|
+
* @interface DefaultApiCheckHandleAvailabilityRequest
|
|
8866
|
+
*/
|
|
8867
|
+
export interface DefaultApiCheckHandleAvailabilityRequest {
|
|
8868
|
+
/**
|
|
8869
|
+
* Workspace handle availability
|
|
8870
|
+
* @type {CheckHandleAvailabilityBody}
|
|
8871
|
+
* @memberof DefaultApiCheckHandleAvailability
|
|
8872
|
+
*/
|
|
8873
|
+
readonly checkHandleAvailabilityBody?: CheckHandleAvailabilityBody;
|
|
8874
|
+
}
|
|
7641
8875
|
/**
|
|
7642
8876
|
* Request parameters for configureIntegration operation in DefaultApi.
|
|
7643
8877
|
* @export
|
|
@@ -7742,6 +8976,19 @@ export interface DefaultApiCreatePersonalAccessTokenRequest {
|
|
|
7742
8976
|
*/
|
|
7743
8977
|
readonly createPersonalAccessTokenBody?: CreatePersonalAccessTokenBody;
|
|
7744
8978
|
}
|
|
8979
|
+
/**
|
|
8980
|
+
* Request parameters for createTask operation in DefaultApi.
|
|
8981
|
+
* @export
|
|
8982
|
+
* @interface DefaultApiCreateTaskRequest
|
|
8983
|
+
*/
|
|
8984
|
+
export interface DefaultApiCreateTaskRequest {
|
|
8985
|
+
/**
|
|
8986
|
+
* Task data
|
|
8987
|
+
* @type {CreateTaskBody}
|
|
8988
|
+
* @memberof DefaultApiCreateTask
|
|
8989
|
+
*/
|
|
8990
|
+
readonly createTaskBody?: CreateTaskBody;
|
|
8991
|
+
}
|
|
7745
8992
|
/**
|
|
7746
8993
|
* Request parameters for createUser operation in DefaultApi.
|
|
7747
8994
|
* @export
|
|
@@ -7878,6 +9125,19 @@ export interface DefaultApiDeletePersonalAccessTokenRequest {
|
|
|
7878
9125
|
*/
|
|
7879
9126
|
readonly id: string;
|
|
7880
9127
|
}
|
|
9128
|
+
/**
|
|
9129
|
+
* Request parameters for deleteTask operation in DefaultApi.
|
|
9130
|
+
* @export
|
|
9131
|
+
* @interface DefaultApiDeleteTaskRequest
|
|
9132
|
+
*/
|
|
9133
|
+
export interface DefaultApiDeleteTaskRequest {
|
|
9134
|
+
/**
|
|
9135
|
+
* Task id
|
|
9136
|
+
* @type {string}
|
|
9137
|
+
* @memberof DefaultApiDeleteTask
|
|
9138
|
+
*/
|
|
9139
|
+
readonly id: string;
|
|
9140
|
+
}
|
|
7881
9141
|
/**
|
|
7882
9142
|
* Request parameters for deleteUser operation in DefaultApi.
|
|
7883
9143
|
* @export
|
|
@@ -7930,6 +9190,19 @@ export interface DefaultApiDownloadFileRequest {
|
|
|
7930
9190
|
*/
|
|
7931
9191
|
readonly id: string;
|
|
7932
9192
|
}
|
|
9193
|
+
/**
|
|
9194
|
+
* Request parameters for getAccountPreference operation in DefaultApi.
|
|
9195
|
+
* @export
|
|
9196
|
+
* @interface DefaultApiGetAccountPreferenceRequest
|
|
9197
|
+
*/
|
|
9198
|
+
export interface DefaultApiGetAccountPreferenceRequest {
|
|
9199
|
+
/**
|
|
9200
|
+
* Preference key
|
|
9201
|
+
* @type {string}
|
|
9202
|
+
* @memberof DefaultApiGetAccountPreference
|
|
9203
|
+
*/
|
|
9204
|
+
readonly key: string;
|
|
9205
|
+
}
|
|
7933
9206
|
/**
|
|
7934
9207
|
* Request parameters for getAuditRecords operation in DefaultApi.
|
|
7935
9208
|
* @export
|
|
@@ -8267,6 +9540,19 @@ export interface DefaultApiGetStateRequest {
|
|
|
8267
9540
|
*/
|
|
8268
9541
|
readonly name: string;
|
|
8269
9542
|
}
|
|
9543
|
+
/**
|
|
9544
|
+
* Request parameters for getTask operation in DefaultApi.
|
|
9545
|
+
* @export
|
|
9546
|
+
* @interface DefaultApiGetTaskRequest
|
|
9547
|
+
*/
|
|
9548
|
+
export interface DefaultApiGetTaskRequest {
|
|
9549
|
+
/**
|
|
9550
|
+
* Task id
|
|
9551
|
+
* @type {string}
|
|
9552
|
+
* @memberof DefaultApiGetTask
|
|
9553
|
+
*/
|
|
9554
|
+
readonly id: string;
|
|
9555
|
+
}
|
|
8270
9556
|
/**
|
|
8271
9557
|
* Request parameters for getUsage operation in DefaultApi.
|
|
8272
9558
|
* @export
|
|
@@ -8611,6 +9897,57 @@ export interface DefaultApiListPublicIntegrationsRequest {
|
|
|
8611
9897
|
*/
|
|
8612
9898
|
readonly version?: string;
|
|
8613
9899
|
}
|
|
9900
|
+
/**
|
|
9901
|
+
* Request parameters for listTasks operation in DefaultApi.
|
|
9902
|
+
* @export
|
|
9903
|
+
* @interface DefaultApiListTasksRequest
|
|
9904
|
+
*/
|
|
9905
|
+
export interface DefaultApiListTasksRequest {
|
|
9906
|
+
/**
|
|
9907
|
+
* Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
|
|
9908
|
+
* @type {string}
|
|
9909
|
+
* @memberof DefaultApiListTasks
|
|
9910
|
+
*/
|
|
9911
|
+
readonly nextToken?: string;
|
|
9912
|
+
/**
|
|
9913
|
+
* Filter by tags
|
|
9914
|
+
* @type {{ [key: string]: string; }}
|
|
9915
|
+
* @memberof DefaultApiListTasks
|
|
9916
|
+
*/
|
|
9917
|
+
readonly tags?: {
|
|
9918
|
+
[key: string]: string;
|
|
9919
|
+
};
|
|
9920
|
+
/**
|
|
9921
|
+
* Conversation id
|
|
9922
|
+
* @type {string}
|
|
9923
|
+
* @memberof DefaultApiListTasks
|
|
9924
|
+
*/
|
|
9925
|
+
readonly conversationId?: string;
|
|
9926
|
+
/**
|
|
9927
|
+
* User id
|
|
9928
|
+
* @type {string}
|
|
9929
|
+
* @memberof DefaultApiListTasks
|
|
9930
|
+
*/
|
|
9931
|
+
readonly userId?: string;
|
|
9932
|
+
/**
|
|
9933
|
+
* Parent task id
|
|
9934
|
+
* @type {string}
|
|
9935
|
+
* @memberof DefaultApiListTasks
|
|
9936
|
+
*/
|
|
9937
|
+
readonly parentTaskId?: string;
|
|
9938
|
+
/**
|
|
9939
|
+
* Status
|
|
9940
|
+
* @type {'pending' | 'in_progress' | 'failed' | 'completed' | 'blocked' | 'paused'}
|
|
9941
|
+
* @memberof DefaultApiListTasks
|
|
9942
|
+
*/
|
|
9943
|
+
readonly status?: ListTasksStatusEnum;
|
|
9944
|
+
/**
|
|
9945
|
+
* Type
|
|
9946
|
+
* @type {string}
|
|
9947
|
+
* @memberof DefaultApiListTasks
|
|
9948
|
+
*/
|
|
9949
|
+
readonly type?: string;
|
|
9950
|
+
}
|
|
8614
9951
|
/**
|
|
8615
9952
|
* Request parameters for listUsageHistory operation in DefaultApi.
|
|
8616
9953
|
* @export
|
|
@@ -8803,6 +10140,25 @@ export interface DefaultApiRunVrlRequest {
|
|
|
8803
10140
|
*/
|
|
8804
10141
|
readonly runVrlBody?: RunVrlBody;
|
|
8805
10142
|
}
|
|
10143
|
+
/**
|
|
10144
|
+
* Request parameters for setAccountPreference operation in DefaultApi.
|
|
10145
|
+
* @export
|
|
10146
|
+
* @interface DefaultApiSetAccountPreferenceRequest
|
|
10147
|
+
*/
|
|
10148
|
+
export interface DefaultApiSetAccountPreferenceRequest {
|
|
10149
|
+
/**
|
|
10150
|
+
* Preference key
|
|
10151
|
+
* @type {string}
|
|
10152
|
+
* @memberof DefaultApiSetAccountPreference
|
|
10153
|
+
*/
|
|
10154
|
+
readonly key: string;
|
|
10155
|
+
/**
|
|
10156
|
+
* Preference value
|
|
10157
|
+
* @type {SetAccountPreferenceBody}
|
|
10158
|
+
* @memberof DefaultApiSetAccountPreference
|
|
10159
|
+
*/
|
|
10160
|
+
readonly setAccountPreferenceBody?: SetAccountPreferenceBody;
|
|
10161
|
+
}
|
|
8806
10162
|
/**
|
|
8807
10163
|
* Request parameters for setState operation in DefaultApi.
|
|
8808
10164
|
* @export
|
|
@@ -8948,6 +10304,25 @@ export interface DefaultApiUpdateMessageRequest {
|
|
|
8948
10304
|
*/
|
|
8949
10305
|
readonly updateMessageBody?: UpdateMessageBody;
|
|
8950
10306
|
}
|
|
10307
|
+
/**
|
|
10308
|
+
* Request parameters for updateTask operation in DefaultApi.
|
|
10309
|
+
* @export
|
|
10310
|
+
* @interface DefaultApiUpdateTaskRequest
|
|
10311
|
+
*/
|
|
10312
|
+
export interface DefaultApiUpdateTaskRequest {
|
|
10313
|
+
/**
|
|
10314
|
+
* Task id
|
|
10315
|
+
* @type {string}
|
|
10316
|
+
* @memberof DefaultApiUpdateTask
|
|
10317
|
+
*/
|
|
10318
|
+
readonly id: string;
|
|
10319
|
+
/**
|
|
10320
|
+
* Task data
|
|
10321
|
+
* @type {UpdateTaskBody}
|
|
10322
|
+
* @memberof DefaultApiUpdateTask
|
|
10323
|
+
*/
|
|
10324
|
+
readonly updateTaskBody?: UpdateTaskBody;
|
|
10325
|
+
}
|
|
8951
10326
|
/**
|
|
8952
10327
|
* Request parameters for updateUser operation in DefaultApi.
|
|
8953
10328
|
* @export
|
|
@@ -9060,6 +10435,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9060
10435
|
* @memberof DefaultApi
|
|
9061
10436
|
*/
|
|
9062
10437
|
chargeWorkspaceUnpaidInvoices(requestParameters: DefaultApiChargeWorkspaceUnpaidInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChargeWorkspaceUnpaidInvoicesResponse, any>>;
|
|
10438
|
+
/**
|
|
10439
|
+
* Check if a workspace handle is available
|
|
10440
|
+
* @param {DefaultApiCheckHandleAvailabilityRequest} requestParameters Request parameters.
|
|
10441
|
+
* @param {*} [options] Override http request option.
|
|
10442
|
+
* @throws {RequiredError}
|
|
10443
|
+
* @memberof DefaultApi
|
|
10444
|
+
*/
|
|
10445
|
+
checkHandleAvailability(requestParameters?: DefaultApiCheckHandleAvailabilityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CheckHandleAvailabilityResponse, any>>;
|
|
9063
10446
|
/**
|
|
9064
10447
|
* An integration can call this endpoint to configure itself
|
|
9065
10448
|
* @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
|
|
@@ -9124,6 +10507,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9124
10507
|
* @memberof DefaultApi
|
|
9125
10508
|
*/
|
|
9126
10509
|
createPersonalAccessToken(requestParameters?: DefaultApiCreatePersonalAccessTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePersonalAccessTokenResponse, any>>;
|
|
10510
|
+
/**
|
|
10511
|
+
* Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.
|
|
10512
|
+
* @param {DefaultApiCreateTaskRequest} requestParameters Request parameters.
|
|
10513
|
+
* @param {*} [options] Override http request option.
|
|
10514
|
+
* @throws {RequiredError}
|
|
10515
|
+
* @memberof DefaultApi
|
|
10516
|
+
*/
|
|
10517
|
+
createTask(requestParameters?: DefaultApiCreateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTaskResponse, any>>;
|
|
9127
10518
|
/**
|
|
9128
10519
|
* Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.
|
|
9129
10520
|
* @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
|
|
@@ -9204,6 +10595,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9204
10595
|
* @memberof DefaultApi
|
|
9205
10596
|
*/
|
|
9206
10597
|
deletePersonalAccessToken(requestParameters: DefaultApiDeletePersonalAccessTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
10598
|
+
/**
|
|
10599
|
+
* Permanently deletes a [Task](#schema_task). It cannot be undone.
|
|
10600
|
+
* @param {DefaultApiDeleteTaskRequest} requestParameters Request parameters.
|
|
10601
|
+
* @param {*} [options] Override http request option.
|
|
10602
|
+
* @throws {RequiredError}
|
|
10603
|
+
* @memberof DefaultApi
|
|
10604
|
+
*/
|
|
10605
|
+
deleteTask(requestParameters: DefaultApiDeleteTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
9207
10606
|
/**
|
|
9208
10607
|
* Permanently deletes a [User](#schema_user). It cannot be undone.
|
|
9209
10608
|
* @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
|
|
@@ -9243,6 +10642,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9243
10642
|
* @memberof DefaultApi
|
|
9244
10643
|
*/
|
|
9245
10644
|
getAccount(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountResponse, any>>;
|
|
10645
|
+
/**
|
|
10646
|
+
* Get a preference of the account
|
|
10647
|
+
* @param {DefaultApiGetAccountPreferenceRequest} requestParameters Request parameters.
|
|
10648
|
+
* @param {*} [options] Override http request option.
|
|
10649
|
+
* @throws {RequiredError}
|
|
10650
|
+
* @memberof DefaultApi
|
|
10651
|
+
*/
|
|
10652
|
+
getAccountPreference(requestParameters: DefaultApiGetAccountPreferenceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountPreferenceResponse, any>>;
|
|
9246
10653
|
/**
|
|
9247
10654
|
* For a user, gets a map of workspace IDs to their highest quota completion rate
|
|
9248
10655
|
* @param {*} [options] Override http request option.
|
|
@@ -9404,6 +10811,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9404
10811
|
* @memberof DefaultApi
|
|
9405
10812
|
*/
|
|
9406
10813
|
getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetStateResponse, any>>;
|
|
10814
|
+
/**
|
|
10815
|
+
* Retrieves the [Task](#schema_task) object for a valid identifier.
|
|
10816
|
+
* @param {DefaultApiGetTaskRequest} requestParameters Request parameters.
|
|
10817
|
+
* @param {*} [options] Override http request option.
|
|
10818
|
+
* @throws {RequiredError}
|
|
10819
|
+
* @memberof DefaultApi
|
|
10820
|
+
*/
|
|
10821
|
+
getTask(requestParameters: DefaultApiGetTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTaskResponse, any>>;
|
|
9407
10822
|
/**
|
|
9408
10823
|
* Get usage
|
|
9409
10824
|
* @param {DefaultApiGetUsageRequest} requestParameters Request parameters.
|
|
@@ -9485,7 +10900,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9485
10900
|
*/
|
|
9486
10901
|
listConversations(requestParameters?: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListConversationsResponse, any>>;
|
|
9487
10902
|
/**
|
|
9488
|
-
*
|
|
10903
|
+
* Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
|
|
9489
10904
|
* @param {DefaultApiListEventsRequest} requestParameters Request parameters.
|
|
9490
10905
|
* @param {*} [options] Override http request option.
|
|
9491
10906
|
* @throws {RequiredError}
|
|
@@ -9539,6 +10954,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9539
10954
|
* @memberof DefaultApi
|
|
9540
10955
|
*/
|
|
9541
10956
|
listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPublicIntegrationsResponse, any>>;
|
|
10957
|
+
/**
|
|
10958
|
+
* Retrieves a list of [Task](#schema_task) you\'ve previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
|
|
10959
|
+
* @param {DefaultApiListTasksRequest} requestParameters Request parameters.
|
|
10960
|
+
* @param {*} [options] Override http request option.
|
|
10961
|
+
* @throws {RequiredError}
|
|
10962
|
+
* @memberof DefaultApi
|
|
10963
|
+
*/
|
|
10964
|
+
listTasks(requestParameters?: DefaultApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponse, any>>;
|
|
9542
10965
|
/**
|
|
9543
10966
|
* Get usage history
|
|
9544
10967
|
* @param {DefaultApiListUsageHistoryRequest} requestParameters Request parameters.
|
|
@@ -9619,6 +11042,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9619
11042
|
* @memberof DefaultApi
|
|
9620
11043
|
*/
|
|
9621
11044
|
runVrl(requestParameters?: DefaultApiRunVrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RunVrlResponse, any>>;
|
|
11045
|
+
/**
|
|
11046
|
+
* Set a preference for the account
|
|
11047
|
+
* @param {DefaultApiSetAccountPreferenceRequest} requestParameters Request parameters.
|
|
11048
|
+
* @param {*} [options] Override http request option.
|
|
11049
|
+
* @throws {RequiredError}
|
|
11050
|
+
* @memberof DefaultApi
|
|
11051
|
+
*/
|
|
11052
|
+
setAccountPreference(requestParameters: DefaultApiSetAccountPreferenceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
9622
11053
|
/**
|
|
9623
11054
|
* Overrides the [State](#schema_state) object by setting the values of the parameters passed.
|
|
9624
11055
|
* @param {DefaultApiSetStateRequest} requestParameters Request parameters.
|
|
@@ -9675,6 +11106,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
9675
11106
|
* @memberof DefaultApi
|
|
9676
11107
|
*/
|
|
9677
11108
|
updateMessage(requestParameters: DefaultApiUpdateMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateMessageResponse, any>>;
|
|
11109
|
+
/**
|
|
11110
|
+
* Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
11111
|
+
* @param {DefaultApiUpdateTaskRequest} requestParameters Request parameters.
|
|
11112
|
+
* @param {*} [options] Override http request option.
|
|
11113
|
+
* @throws {RequiredError}
|
|
11114
|
+
* @memberof DefaultApi
|
|
11115
|
+
*/
|
|
11116
|
+
updateTask(requestParameters: DefaultApiUpdateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTaskResponse, any>>;
|
|
9678
11117
|
/**
|
|
9679
11118
|
* Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
9680
11119
|
* @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
|
|
@@ -9777,6 +11216,18 @@ export declare const GetWorkspaceQuotaTypeEnum: {
|
|
|
9777
11216
|
readonly AlwaysAlive: "always_alive";
|
|
9778
11217
|
};
|
|
9779
11218
|
export type GetWorkspaceQuotaTypeEnum = typeof GetWorkspaceQuotaTypeEnum[keyof typeof GetWorkspaceQuotaTypeEnum];
|
|
11219
|
+
/**
|
|
11220
|
+
* @export
|
|
11221
|
+
*/
|
|
11222
|
+
export declare const ListTasksStatusEnum: {
|
|
11223
|
+
readonly Pending: "pending";
|
|
11224
|
+
readonly InProgress: "in_progress";
|
|
11225
|
+
readonly Failed: "failed";
|
|
11226
|
+
readonly Completed: "completed";
|
|
11227
|
+
readonly Blocked: "blocked";
|
|
11228
|
+
readonly Paused: "paused";
|
|
11229
|
+
};
|
|
11230
|
+
export type ListTasksStatusEnum = typeof ListTasksStatusEnum[keyof typeof ListTasksStatusEnum];
|
|
9780
11231
|
/**
|
|
9781
11232
|
* @export
|
|
9782
11233
|
*/
|