@scout9/admin 1.0.0-alpha.0 → 1.0.0-alpha.0.0.2
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/README.md +349 -33
- package/build/api.d.ts +89 -101
- package/build/api.js +163 -163
- package/build/index.d.ts +1 -0
- package/build/index.js +1 -0
- package/build/webhooks.d.ts +11 -0
- package/build/webhooks.js +50 -0
- package/package.json +1 -1
- package/src/api.ts +159 -171
- package/src/index.ts +2 -1
- package/src/webhooks.ts +30 -0
- package/tsconfig.tsbuildinfo +1 -1
package/build/api.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Scout9
|
|
3
|
-
*
|
|
2
|
+
* Scout9 API
|
|
3
|
+
* Scout9 APIs for managing Scout9 users and conversations with your Scout9 agents
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0.0
|
|
6
6
|
*
|
|
@@ -100,7 +100,7 @@ export interface Agent {
|
|
|
100
100
|
'excludedLocations'?: Array<string>;
|
|
101
101
|
}
|
|
102
102
|
export declare const AgentModelEnum: {
|
|
103
|
-
readonly
|
|
103
|
+
readonly Scout9: "Scout9";
|
|
104
104
|
readonly Bard: "bard";
|
|
105
105
|
readonly Null: "null";
|
|
106
106
|
};
|
|
@@ -647,12 +647,6 @@ export interface ConversationCreateResponse {
|
|
|
647
647
|
* @memberof ConversationCreateResponse
|
|
648
648
|
*/
|
|
649
649
|
'agentTestWebUrl'?: string;
|
|
650
|
-
/**
|
|
651
|
-
* The ID of the conversation
|
|
652
|
-
* @type {string}
|
|
653
|
-
* @memberof ConversationCreateResponse
|
|
654
|
-
*/
|
|
655
|
-
'$id': string;
|
|
656
650
|
/**
|
|
657
651
|
* ISO 8601 date string of when the conversation was initiated
|
|
658
652
|
* @type {string}
|
|
@@ -666,12 +660,6 @@ export interface ConversationCreateResponse {
|
|
|
666
660
|
* @interface ConversationCreateResponseAllOf
|
|
667
661
|
*/
|
|
668
662
|
export interface ConversationCreateResponseAllOf {
|
|
669
|
-
/**
|
|
670
|
-
* The ID of the conversation
|
|
671
|
-
* @type {string}
|
|
672
|
-
* @memberof ConversationCreateResponseAllOf
|
|
673
|
-
*/
|
|
674
|
-
'$id': string;
|
|
675
663
|
/**
|
|
676
664
|
* ISO 8601 date string of when the conversation was initiated
|
|
677
665
|
* @type {string}
|
|
@@ -1084,7 +1072,7 @@ export interface CreateAgentRequest {
|
|
|
1084
1072
|
'audio'?: Array<string>;
|
|
1085
1073
|
}
|
|
1086
1074
|
export declare const CreateAgentRequestModelEnum: {
|
|
1087
|
-
readonly
|
|
1075
|
+
readonly Scout9: "Scout9";
|
|
1088
1076
|
readonly Bard: "bard";
|
|
1089
1077
|
readonly Null: "null";
|
|
1090
1078
|
};
|
|
@@ -1281,7 +1269,7 @@ export interface CreateAgentsRequestAgentsInner {
|
|
|
1281
1269
|
'excludedLocations'?: Array<string>;
|
|
1282
1270
|
}
|
|
1283
1271
|
export declare const CreateAgentsRequestAgentsInnerModelEnum: {
|
|
1284
|
-
readonly
|
|
1272
|
+
readonly Scout9: "Scout9";
|
|
1285
1273
|
readonly Bard: "bard";
|
|
1286
1274
|
readonly Null: "null";
|
|
1287
1275
|
};
|
|
@@ -1902,7 +1890,7 @@ export interface CreateWorkflowsResponse {
|
|
|
1902
1890
|
'$operation': string;
|
|
1903
1891
|
}
|
|
1904
1892
|
/**
|
|
1905
|
-
*
|
|
1893
|
+
* Represents a customer for your business or organization
|
|
1906
1894
|
* @export
|
|
1907
1895
|
* @interface Customer
|
|
1908
1896
|
*/
|
|
@@ -2566,7 +2554,7 @@ export interface GetAgentResponse {
|
|
|
2566
2554
|
'$id': string;
|
|
2567
2555
|
}
|
|
2568
2556
|
export declare const GetAgentResponseModelEnum: {
|
|
2569
|
-
readonly
|
|
2557
|
+
readonly Scout9: "Scout9";
|
|
2570
2558
|
readonly Bard: "bard";
|
|
2571
2559
|
readonly Null: "null";
|
|
2572
2560
|
};
|
|
@@ -3076,7 +3064,7 @@ export interface ListAgentsResponseInner {
|
|
|
3076
3064
|
'$id': string;
|
|
3077
3065
|
}
|
|
3078
3066
|
export declare const ListAgentsResponseInnerModelEnum: {
|
|
3079
|
-
readonly
|
|
3067
|
+
readonly Scout9: "Scout9";
|
|
3080
3068
|
readonly Bard: "bard";
|
|
3081
3069
|
readonly Null: "null";
|
|
3082
3070
|
};
|
|
@@ -4857,7 +4845,7 @@ export interface UpdateAgentRequest {
|
|
|
4857
4845
|
'excludedLocations'?: Array<string>;
|
|
4858
4846
|
}
|
|
4859
4847
|
export declare const UpdateAgentRequestModelEnum: {
|
|
4860
|
-
readonly
|
|
4848
|
+
readonly Scout9: "Scout9";
|
|
4861
4849
|
readonly Bard: "bard";
|
|
4862
4850
|
readonly Null: "null";
|
|
4863
4851
|
};
|
|
@@ -5017,7 +5005,7 @@ export interface UpdateAgentsRequestAgentsInner {
|
|
|
5017
5005
|
'$id': string;
|
|
5018
5006
|
}
|
|
5019
5007
|
export declare const UpdateAgentsRequestAgentsInnerModelEnum: {
|
|
5020
|
-
readonly
|
|
5008
|
+
readonly Scout9: "Scout9";
|
|
5021
5009
|
readonly Bard: "bard";
|
|
5022
5010
|
readonly Null: "null";
|
|
5023
5011
|
};
|
|
@@ -5678,10 +5666,10 @@ export interface Workflow {
|
|
|
5678
5666
|
'onError'?: string;
|
|
5679
5667
|
}
|
|
5680
5668
|
/**
|
|
5681
|
-
*
|
|
5669
|
+
* Scout9Api - axios parameter creator
|
|
5682
5670
|
* @export
|
|
5683
5671
|
*/
|
|
5684
|
-
export declare const
|
|
5672
|
+
export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
5685
5673
|
/**
|
|
5686
5674
|
*
|
|
5687
5675
|
* @summary Gets a agent
|
|
@@ -5847,11 +5835,11 @@ export declare const PocketScoutApiAxiosParamCreator: (configuration?: Configura
|
|
|
5847
5835
|
/**
|
|
5848
5836
|
*
|
|
5849
5837
|
* @summary Gets a customer
|
|
5850
|
-
* @param {string}
|
|
5838
|
+
* @param {string} idOrEmailOrPhone id of customer or their registered phone or registered email
|
|
5851
5839
|
* @param {*} [options] Override http request option.
|
|
5852
5840
|
* @throws {RequiredError}
|
|
5853
5841
|
*/
|
|
5854
|
-
customer: (
|
|
5842
|
+
customer: (idOrEmailOrPhone: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5855
5843
|
/**
|
|
5856
5844
|
*
|
|
5857
5845
|
* @summary Creates a new customer
|
|
@@ -6187,10 +6175,10 @@ export declare const PocketScoutApiAxiosParamCreator: (configuration?: Configura
|
|
|
6187
6175
|
workflowsUpdate: (updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6188
6176
|
};
|
|
6189
6177
|
/**
|
|
6190
|
-
*
|
|
6178
|
+
* Scout9Api - functional programming interface
|
|
6191
6179
|
* @export
|
|
6192
6180
|
*/
|
|
6193
|
-
export declare const
|
|
6181
|
+
export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
6194
6182
|
/**
|
|
6195
6183
|
*
|
|
6196
6184
|
* @summary Gets a agent
|
|
@@ -6356,11 +6344,11 @@ export declare const PocketScoutApiFp: (configuration?: Configuration) => {
|
|
|
6356
6344
|
/**
|
|
6357
6345
|
*
|
|
6358
6346
|
* @summary Gets a customer
|
|
6359
|
-
* @param {string}
|
|
6347
|
+
* @param {string} idOrEmailOrPhone id of customer or their registered phone or registered email
|
|
6360
6348
|
* @param {*} [options] Override http request option.
|
|
6361
6349
|
* @throws {RequiredError}
|
|
6362
6350
|
*/
|
|
6363
|
-
customer(
|
|
6351
|
+
customer(idOrEmailOrPhone: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerResponse>>;
|
|
6364
6352
|
/**
|
|
6365
6353
|
*
|
|
6366
6354
|
* @summary Creates a new customer
|
|
@@ -6696,10 +6684,10 @@ export declare const PocketScoutApiFp: (configuration?: Configuration) => {
|
|
|
6696
6684
|
workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateWorkflowsResponse>>;
|
|
6697
6685
|
};
|
|
6698
6686
|
/**
|
|
6699
|
-
*
|
|
6687
|
+
* Scout9Api - factory interface
|
|
6700
6688
|
* @export
|
|
6701
6689
|
*/
|
|
6702
|
-
export declare const
|
|
6690
|
+
export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
6703
6691
|
/**
|
|
6704
6692
|
*
|
|
6705
6693
|
* @summary Gets a agent
|
|
@@ -6865,11 +6853,11 @@ export declare const PocketScoutApiFactory: (configuration?: Configuration, base
|
|
|
6865
6853
|
/**
|
|
6866
6854
|
*
|
|
6867
6855
|
* @summary Gets a customer
|
|
6868
|
-
* @param {string}
|
|
6856
|
+
* @param {string} idOrEmailOrPhone id of customer or their registered phone or registered email
|
|
6869
6857
|
* @param {*} [options] Override http request option.
|
|
6870
6858
|
* @throws {RequiredError}
|
|
6871
6859
|
*/
|
|
6872
|
-
customer(
|
|
6860
|
+
customer(idOrEmailOrPhone: string, options?: any): AxiosPromise<GetCustomerResponse>;
|
|
6873
6861
|
/**
|
|
6874
6862
|
*
|
|
6875
6863
|
* @summary Creates a new customer
|
|
@@ -7205,19 +7193,19 @@ export declare const PocketScoutApiFactory: (configuration?: Configuration, base
|
|
|
7205
7193
|
workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: any): AxiosPromise<UpdateWorkflowsResponse>;
|
|
7206
7194
|
};
|
|
7207
7195
|
/**
|
|
7208
|
-
*
|
|
7196
|
+
* Scout9Api - object-oriented interface
|
|
7209
7197
|
* @export
|
|
7210
|
-
* @class
|
|
7198
|
+
* @class Scout9Api
|
|
7211
7199
|
* @extends {BaseAPI}
|
|
7212
7200
|
*/
|
|
7213
|
-
export declare class
|
|
7201
|
+
export declare class Scout9Api extends BaseAPI {
|
|
7214
7202
|
/**
|
|
7215
7203
|
*
|
|
7216
7204
|
* @summary Gets a agent
|
|
7217
7205
|
* @param {string} id id of entity to query
|
|
7218
7206
|
* @param {*} [options] Override http request option.
|
|
7219
7207
|
* @throws {RequiredError}
|
|
7220
|
-
* @memberof
|
|
7208
|
+
* @memberof Scout9Api
|
|
7221
7209
|
*/
|
|
7222
7210
|
agent(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAgentResponse, any>>;
|
|
7223
7211
|
/**
|
|
@@ -7226,7 +7214,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7226
7214
|
* @param {string} id id of entity to query
|
|
7227
7215
|
* @param {*} [options] Override http request option.
|
|
7228
7216
|
* @throws {RequiredError}
|
|
7229
|
-
* @memberof
|
|
7217
|
+
* @memberof Scout9Api
|
|
7230
7218
|
*/
|
|
7231
7219
|
agentDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteAgentResponse, any>>;
|
|
7232
7220
|
/**
|
|
@@ -7235,7 +7223,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7235
7223
|
* @param {CreateAgentRequest} createAgentRequest
|
|
7236
7224
|
* @param {*} [options] Override http request option.
|
|
7237
7225
|
* @throws {RequiredError}
|
|
7238
|
-
* @memberof
|
|
7226
|
+
* @memberof Scout9Api
|
|
7239
7227
|
*/
|
|
7240
7228
|
agentRegister(createAgentRequest: CreateAgentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAgentResponse, any>>;
|
|
7241
7229
|
/**
|
|
@@ -7244,7 +7232,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7244
7232
|
* @param {UpdateAgentRequest} updateAgentRequest
|
|
7245
7233
|
* @param {*} [options] Override http request option.
|
|
7246
7234
|
* @throws {RequiredError}
|
|
7247
|
-
* @memberof
|
|
7235
|
+
* @memberof Scout9Api
|
|
7248
7236
|
*/
|
|
7249
7237
|
agentUpdate(updateAgentRequest: UpdateAgentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAgentResponse, any>>;
|
|
7250
7238
|
/**
|
|
@@ -7254,7 +7242,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7254
7242
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7255
7243
|
* @param {*} [options] Override http request option.
|
|
7256
7244
|
* @throws {RequiredError}
|
|
7257
|
-
* @memberof
|
|
7245
|
+
* @memberof Scout9Api
|
|
7258
7246
|
*/
|
|
7259
7247
|
agents(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAgentsResponseInner[], any>>;
|
|
7260
7248
|
/**
|
|
@@ -7263,7 +7251,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7263
7251
|
* @param {CreateAgentsRequest} createAgentsRequest
|
|
7264
7252
|
* @param {*} [options] Override http request option.
|
|
7265
7253
|
* @throws {RequiredError}
|
|
7266
|
-
* @memberof
|
|
7254
|
+
* @memberof Scout9Api
|
|
7267
7255
|
*/
|
|
7268
7256
|
agentsCreate(createAgentsRequest: CreateAgentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAgentsResponse, any>>;
|
|
7269
7257
|
/**
|
|
@@ -7272,7 +7260,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7272
7260
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7273
7261
|
* @param {*} [options] Override http request option.
|
|
7274
7262
|
* @throws {RequiredError}
|
|
7275
|
-
* @memberof
|
|
7263
|
+
* @memberof Scout9Api
|
|
7276
7264
|
*/
|
|
7277
7265
|
agentsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteAgentsResponse, any>>;
|
|
7278
7266
|
/**
|
|
@@ -7281,7 +7269,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7281
7269
|
* @param {UpdateAgentsRequest} updateAgentsRequest
|
|
7282
7270
|
* @param {*} [options] Override http request option.
|
|
7283
7271
|
* @throws {RequiredError}
|
|
7284
|
-
* @memberof
|
|
7272
|
+
* @memberof Scout9Api
|
|
7285
7273
|
*/
|
|
7286
7274
|
agentsUpdate(updateAgentsRequest: UpdateAgentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAgentsResponse, any>>;
|
|
7287
7275
|
/**
|
|
@@ -7290,7 +7278,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7290
7278
|
* @param {string} id id of entity to query
|
|
7291
7279
|
* @param {*} [options] Override http request option.
|
|
7292
7280
|
* @throws {RequiredError}
|
|
7293
|
-
* @memberof
|
|
7281
|
+
* @memberof Scout9Api
|
|
7294
7282
|
*/
|
|
7295
7283
|
context(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetContextResponse, any>>;
|
|
7296
7284
|
/**
|
|
@@ -7299,7 +7287,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7299
7287
|
* @param {CreateContextRequest} createContextRequest
|
|
7300
7288
|
* @param {*} [options] Override http request option.
|
|
7301
7289
|
* @throws {RequiredError}
|
|
7302
|
-
* @memberof
|
|
7290
|
+
* @memberof Scout9Api
|
|
7303
7291
|
*/
|
|
7304
7292
|
contextCreate(createContextRequest: CreateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextResponse, any>>;
|
|
7305
7293
|
/**
|
|
@@ -7308,7 +7296,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7308
7296
|
* @param {string} id id of entity to query
|
|
7309
7297
|
* @param {*} [options] Override http request option.
|
|
7310
7298
|
* @throws {RequiredError}
|
|
7311
|
-
* @memberof
|
|
7299
|
+
* @memberof Scout9Api
|
|
7312
7300
|
*/
|
|
7313
7301
|
contextDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextResponse, any>>;
|
|
7314
7302
|
/**
|
|
@@ -7317,7 +7305,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7317
7305
|
* @param {UpdateContextRequest} updateContextRequest
|
|
7318
7306
|
* @param {*} [options] Override http request option.
|
|
7319
7307
|
* @throws {RequiredError}
|
|
7320
|
-
* @memberof
|
|
7308
|
+
* @memberof Scout9Api
|
|
7321
7309
|
*/
|
|
7322
7310
|
contextUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextResponse, any>>;
|
|
7323
7311
|
/**
|
|
@@ -7327,7 +7315,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7327
7315
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7328
7316
|
* @param {*} [options] Override http request option.
|
|
7329
7317
|
* @throws {RequiredError}
|
|
7330
|
-
* @memberof
|
|
7318
|
+
* @memberof Scout9Api
|
|
7331
7319
|
*/
|
|
7332
7320
|
contexts(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListContextsResponseInner[], any>>;
|
|
7333
7321
|
/**
|
|
@@ -7336,7 +7324,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7336
7324
|
* @param {CreateContextsRequest} createContextsRequest
|
|
7337
7325
|
* @param {*} [options] Override http request option.
|
|
7338
7326
|
* @throws {RequiredError}
|
|
7339
|
-
* @memberof
|
|
7327
|
+
* @memberof Scout9Api
|
|
7340
7328
|
*/
|
|
7341
7329
|
contextsCreate(createContextsRequest: CreateContextsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateContextsResponse, any>>;
|
|
7342
7330
|
/**
|
|
@@ -7345,7 +7333,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7345
7333
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7346
7334
|
* @param {*} [options] Override http request option.
|
|
7347
7335
|
* @throws {RequiredError}
|
|
7348
|
-
* @memberof
|
|
7336
|
+
* @memberof Scout9Api
|
|
7349
7337
|
*/
|
|
7350
7338
|
contextsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteContextsResponse, any>>;
|
|
7351
7339
|
/**
|
|
@@ -7354,7 +7342,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7354
7342
|
* @param {UpdateContextRequest} updateContextRequest
|
|
7355
7343
|
* @param {*} [options] Override http request option.
|
|
7356
7344
|
* @throws {RequiredError}
|
|
7357
|
-
* @memberof
|
|
7345
|
+
* @memberof Scout9Api
|
|
7358
7346
|
*/
|
|
7359
7347
|
contextsUpdate(updateContextRequest: UpdateContextRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateContextsResponse, any>>;
|
|
7360
7348
|
/**
|
|
@@ -7363,7 +7351,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7363
7351
|
* @param {string} id id of entity to query
|
|
7364
7352
|
* @param {*} [options] Override http request option.
|
|
7365
7353
|
* @throws {RequiredError}
|
|
7366
|
-
* @memberof
|
|
7354
|
+
* @memberof Scout9Api
|
|
7367
7355
|
*/
|
|
7368
7356
|
conversation(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationGetResponse, any>>;
|
|
7369
7357
|
/**
|
|
@@ -7372,7 +7360,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7372
7360
|
* @param {ConversationCreateRequest} conversationCreateRequest
|
|
7373
7361
|
* @param {*} [options] Override http request option.
|
|
7374
7362
|
* @throws {RequiredError}
|
|
7375
|
-
* @memberof
|
|
7363
|
+
* @memberof Scout9Api
|
|
7376
7364
|
*/
|
|
7377
7365
|
conversationCreate(conversationCreateRequest: ConversationCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationCreateResponse, any>>;
|
|
7378
7366
|
/**
|
|
@@ -7381,7 +7369,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7381
7369
|
* @param {string} id id of entity to query
|
|
7382
7370
|
* @param {*} [options] Override http request option.
|
|
7383
7371
|
* @throws {RequiredError}
|
|
7384
|
-
* @memberof
|
|
7372
|
+
* @memberof Scout9Api
|
|
7385
7373
|
*/
|
|
7386
7374
|
conversationDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationRemoveResponse, any>>;
|
|
7387
7375
|
/**
|
|
@@ -7390,25 +7378,25 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7390
7378
|
* @param {ConversationUpdateRequest} conversationUpdateRequest
|
|
7391
7379
|
* @param {*} [options] Override http request option.
|
|
7392
7380
|
* @throws {RequiredError}
|
|
7393
|
-
* @memberof
|
|
7381
|
+
* @memberof Scout9Api
|
|
7394
7382
|
*/
|
|
7395
7383
|
conversationUpdate(conversationUpdateRequest: ConversationUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConversationUpdateResponse, any>>;
|
|
7396
7384
|
/**
|
|
7397
7385
|
*
|
|
7398
7386
|
* @summary Gets a customer
|
|
7399
|
-
* @param {string}
|
|
7387
|
+
* @param {string} idOrEmailOrPhone id of customer or their registered phone or registered email
|
|
7400
7388
|
* @param {*} [options] Override http request option.
|
|
7401
7389
|
* @throws {RequiredError}
|
|
7402
|
-
* @memberof
|
|
7390
|
+
* @memberof Scout9Api
|
|
7403
7391
|
*/
|
|
7404
|
-
customer(
|
|
7392
|
+
customer(idOrEmailOrPhone: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerResponse, any>>;
|
|
7405
7393
|
/**
|
|
7406
7394
|
*
|
|
7407
7395
|
* @summary Creates a new customer
|
|
7408
7396
|
* @param {CreateCustomerRequest} createCustomerRequest
|
|
7409
7397
|
* @param {*} [options] Override http request option.
|
|
7410
7398
|
* @throws {RequiredError}
|
|
7411
|
-
* @memberof
|
|
7399
|
+
* @memberof Scout9Api
|
|
7412
7400
|
*/
|
|
7413
7401
|
customerCreate(createCustomerRequest: CreateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerResponse, any>>;
|
|
7414
7402
|
/**
|
|
@@ -7417,7 +7405,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7417
7405
|
* @param {string} id id of entity to query
|
|
7418
7406
|
* @param {*} [options] Override http request option.
|
|
7419
7407
|
* @throws {RequiredError}
|
|
7420
|
-
* @memberof
|
|
7408
|
+
* @memberof Scout9Api
|
|
7421
7409
|
*/
|
|
7422
7410
|
customerDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerResponse, any>>;
|
|
7423
7411
|
/**
|
|
@@ -7426,7 +7414,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7426
7414
|
* @param {string} id id of entity to query
|
|
7427
7415
|
* @param {*} [options] Override http request option.
|
|
7428
7416
|
* @throws {RequiredError}
|
|
7429
|
-
* @memberof
|
|
7417
|
+
* @memberof Scout9Api
|
|
7430
7418
|
*/
|
|
7431
7419
|
customerGroup(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerGroupResponse, any>>;
|
|
7432
7420
|
/**
|
|
@@ -7435,7 +7423,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7435
7423
|
* @param {CreateCustomerGroupRequest} createCustomerGroupRequest
|
|
7436
7424
|
* @param {*} [options] Override http request option.
|
|
7437
7425
|
* @throws {RequiredError}
|
|
7438
|
-
* @memberof
|
|
7426
|
+
* @memberof Scout9Api
|
|
7439
7427
|
*/
|
|
7440
7428
|
customerGroupCreate(createCustomerGroupRequest: CreateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerGroupResponse, any>>;
|
|
7441
7429
|
/**
|
|
@@ -7444,7 +7432,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7444
7432
|
* @param {string} id id of entity to query
|
|
7445
7433
|
* @param {*} [options] Override http request option.
|
|
7446
7434
|
* @throws {RequiredError}
|
|
7447
|
-
* @memberof
|
|
7435
|
+
* @memberof Scout9Api
|
|
7448
7436
|
*/
|
|
7449
7437
|
customerGroupDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerGroupResponse, any>>;
|
|
7450
7438
|
/**
|
|
@@ -7453,7 +7441,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7453
7441
|
* @param {UpdateCustomerGroupRequest} updateCustomerGroupRequest
|
|
7454
7442
|
* @param {*} [options] Override http request option.
|
|
7455
7443
|
* @throws {RequiredError}
|
|
7456
|
-
* @memberof
|
|
7444
|
+
* @memberof Scout9Api
|
|
7457
7445
|
*/
|
|
7458
7446
|
customerGroupUpdate(updateCustomerGroupRequest: UpdateCustomerGroupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerGroupResponse, any>>;
|
|
7459
7447
|
/**
|
|
@@ -7463,7 +7451,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7463
7451
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7464
7452
|
* @param {*} [options] Override http request option.
|
|
7465
7453
|
* @throws {RequiredError}
|
|
7466
|
-
* @memberof
|
|
7454
|
+
* @memberof Scout9Api
|
|
7467
7455
|
*/
|
|
7468
7456
|
customerGroups(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerGroupsResponseInner[], any>>;
|
|
7469
7457
|
/**
|
|
@@ -7472,7 +7460,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7472
7460
|
* @param {CreateCustomerGroupsRequest} createCustomerGroupsRequest
|
|
7473
7461
|
* @param {*} [options] Override http request option.
|
|
7474
7462
|
* @throws {RequiredError}
|
|
7475
|
-
* @memberof
|
|
7463
|
+
* @memberof Scout9Api
|
|
7476
7464
|
*/
|
|
7477
7465
|
customerGroupsCreate(createCustomerGroupsRequest: CreateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerGroupsResponse, any>>;
|
|
7478
7466
|
/**
|
|
@@ -7481,7 +7469,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7481
7469
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7482
7470
|
* @param {*} [options] Override http request option.
|
|
7483
7471
|
* @throws {RequiredError}
|
|
7484
|
-
* @memberof
|
|
7472
|
+
* @memberof Scout9Api
|
|
7485
7473
|
*/
|
|
7486
7474
|
customerGroupsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomerGroupsResponse, any>>;
|
|
7487
7475
|
/**
|
|
@@ -7490,7 +7478,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7490
7478
|
* @param {UpdateCustomerGroupsRequest} updateCustomerGroupsRequest
|
|
7491
7479
|
* @param {*} [options] Override http request option.
|
|
7492
7480
|
* @throws {RequiredError}
|
|
7493
|
-
* @memberof
|
|
7481
|
+
* @memberof Scout9Api
|
|
7494
7482
|
*/
|
|
7495
7483
|
customerGroupsUpdate(updateCustomerGroupsRequest: UpdateCustomerGroupsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerGroupsResponse, any>>;
|
|
7496
7484
|
/**
|
|
@@ -7499,7 +7487,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7499
7487
|
* @param {UpdateCustomerRequest} updateCustomerRequest
|
|
7500
7488
|
* @param {*} [options] Override http request option.
|
|
7501
7489
|
* @throws {RequiredError}
|
|
7502
|
-
* @memberof
|
|
7490
|
+
* @memberof Scout9Api
|
|
7503
7491
|
*/
|
|
7504
7492
|
customerUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerResponse, any>>;
|
|
7505
7493
|
/**
|
|
@@ -7509,7 +7497,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7509
7497
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7510
7498
|
* @param {*} [options] Override http request option.
|
|
7511
7499
|
* @throws {RequiredError}
|
|
7512
|
-
* @memberof
|
|
7500
|
+
* @memberof Scout9Api
|
|
7513
7501
|
*/
|
|
7514
7502
|
customers(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomersResponseInner[], any>>;
|
|
7515
7503
|
/**
|
|
@@ -7518,7 +7506,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7518
7506
|
* @param {CreateCustomersRequest} createCustomersRequest
|
|
7519
7507
|
* @param {*} [options] Override http request option.
|
|
7520
7508
|
* @throws {RequiredError}
|
|
7521
|
-
* @memberof
|
|
7509
|
+
* @memberof Scout9Api
|
|
7522
7510
|
*/
|
|
7523
7511
|
customersCreate(createCustomersRequest: CreateCustomersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomersResponse, any>>;
|
|
7524
7512
|
/**
|
|
@@ -7527,7 +7515,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7527
7515
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7528
7516
|
* @param {*} [options] Override http request option.
|
|
7529
7517
|
* @throws {RequiredError}
|
|
7530
|
-
* @memberof
|
|
7518
|
+
* @memberof Scout9Api
|
|
7531
7519
|
*/
|
|
7532
7520
|
customersDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteCustomersResponse, any>>;
|
|
7533
7521
|
/**
|
|
@@ -7536,7 +7524,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7536
7524
|
* @param {UpdateCustomerRequest} updateCustomerRequest
|
|
7537
7525
|
* @param {*} [options] Override http request option.
|
|
7538
7526
|
* @throws {RequiredError}
|
|
7539
|
-
* @memberof
|
|
7527
|
+
* @memberof Scout9Api
|
|
7540
7528
|
*/
|
|
7541
7529
|
customersUpdate(updateCustomerRequest: UpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomersResponse, any>>;
|
|
7542
7530
|
/**
|
|
@@ -7545,7 +7533,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7545
7533
|
* @param {string} fileId The ID of the file to use for this request
|
|
7546
7534
|
* @param {*} [options] Override http request option.
|
|
7547
7535
|
* @throws {RequiredError}
|
|
7548
|
-
* @memberof
|
|
7536
|
+
* @memberof Scout9Api
|
|
7549
7537
|
*/
|
|
7550
7538
|
file(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scout9File, any>>;
|
|
7551
7539
|
/**
|
|
@@ -7555,7 +7543,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7555
7543
|
* @param {string} [purpose] The intended purpose of the uploaded documents. This allows us to validate the format of the uploaded file.
|
|
7556
7544
|
* @param {*} [options] Override http request option.
|
|
7557
7545
|
* @throws {RequiredError}
|
|
7558
|
-
* @memberof
|
|
7546
|
+
* @memberof Scout9Api
|
|
7559
7547
|
*/
|
|
7560
7548
|
fileCreate(file: File | Buffer | Blob, purpose?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Scout9File, any>>;
|
|
7561
7549
|
/**
|
|
@@ -7564,7 +7552,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7564
7552
|
* @param {string} fileId The ID of the file to use for this request
|
|
7565
7553
|
* @param {*} [options] Override http request option.
|
|
7566
7554
|
* @throws {RequiredError}
|
|
7567
|
-
* @memberof
|
|
7555
|
+
* @memberof Scout9Api
|
|
7568
7556
|
*/
|
|
7569
7557
|
fileDelete(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteFileResponse, any>>;
|
|
7570
7558
|
/**
|
|
@@ -7573,7 +7561,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7573
7561
|
* @param {string} fileId The ID of the file to use for this request
|
|
7574
7562
|
* @param {*} [options] Override http request option.
|
|
7575
7563
|
* @throws {RequiredError}
|
|
7576
|
-
* @memberof
|
|
7564
|
+
* @memberof Scout9Api
|
|
7577
7565
|
*/
|
|
7578
7566
|
fileDownload(fileId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
7579
7567
|
/**
|
|
@@ -7581,7 +7569,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7581
7569
|
* @summary Returns a list of files that belong to the user\'s organization.
|
|
7582
7570
|
* @param {*} [options] Override http request option.
|
|
7583
7571
|
* @throws {RequiredError}
|
|
7584
|
-
* @memberof
|
|
7572
|
+
* @memberof Scout9Api
|
|
7585
7573
|
*/
|
|
7586
7574
|
files(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFilesResponse, any>>;
|
|
7587
7575
|
/**
|
|
@@ -7590,7 +7578,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7590
7578
|
* @param {GenerateRequest} generateRequest
|
|
7591
7579
|
* @param {*} [options] Override http request option.
|
|
7592
7580
|
* @throws {RequiredError}
|
|
7593
|
-
* @memberof
|
|
7581
|
+
* @memberof Scout9Api
|
|
7594
7582
|
*/
|
|
7595
7583
|
generate(generateRequest: GenerateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateResponse, any>>;
|
|
7596
7584
|
/**
|
|
@@ -7599,7 +7587,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7599
7587
|
* @param {MessageCreateRequest} messageCreateRequest
|
|
7600
7588
|
* @param {*} [options] Override http request option.
|
|
7601
7589
|
* @throws {RequiredError}
|
|
7602
|
-
* @memberof
|
|
7590
|
+
* @memberof Scout9Api
|
|
7603
7591
|
*/
|
|
7604
7592
|
message(messageCreateRequest: MessageCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageCreateResponse, any>>;
|
|
7605
7593
|
/**
|
|
@@ -7609,7 +7597,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7609
7597
|
* @param {string} [q] Query search string to filter results ({field},{operator},{value}) (example firstName,equals,Patrick)
|
|
7610
7598
|
* @param {*} [options] Override http request option.
|
|
7611
7599
|
* @throws {RequiredError}
|
|
7612
|
-
* @memberof
|
|
7600
|
+
* @memberof Scout9Api
|
|
7613
7601
|
*/
|
|
7614
7602
|
messages(id: string, q?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageGetResponseInner[], any>>;
|
|
7615
7603
|
/**
|
|
@@ -7618,7 +7606,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7618
7606
|
* @param {string} id id of entity to query
|
|
7619
7607
|
* @param {*} [options] Override http request option.
|
|
7620
7608
|
* @throws {RequiredError}
|
|
7621
|
-
* @memberof
|
|
7609
|
+
* @memberof Scout9Api
|
|
7622
7610
|
*/
|
|
7623
7611
|
operation(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetApiOperationResponse, any>>;
|
|
7624
7612
|
/**
|
|
@@ -7628,7 +7616,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7628
7616
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7629
7617
|
* @param {*} [options] Override http request option.
|
|
7630
7618
|
* @throws {RequiredError}
|
|
7631
|
-
* @memberof
|
|
7619
|
+
* @memberof Scout9Api
|
|
7632
7620
|
*/
|
|
7633
7621
|
operations(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListApiOperationsResponseInner[], any>>;
|
|
7634
7622
|
/**
|
|
@@ -7637,7 +7625,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7637
7625
|
* @param {ScheduleCreateRequest} scheduleCreateRequest
|
|
7638
7626
|
* @param {*} [options] Override http request option.
|
|
7639
7627
|
* @throws {RequiredError}
|
|
7640
|
-
* @memberof
|
|
7628
|
+
* @memberof Scout9Api
|
|
7641
7629
|
*/
|
|
7642
7630
|
scheduleConversation(scheduleCreateRequest: ScheduleCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleCreateResponse, any>>;
|
|
7643
7631
|
/**
|
|
@@ -7646,7 +7634,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7646
7634
|
* @param {string} id id of entity to query
|
|
7647
7635
|
* @param {*} [options] Override http request option.
|
|
7648
7636
|
* @throws {RequiredError}
|
|
7649
|
-
* @memberof
|
|
7637
|
+
* @memberof Scout9Api
|
|
7650
7638
|
*/
|
|
7651
7639
|
scheduleDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleRemoveResponse, any>>;
|
|
7652
7640
|
/**
|
|
@@ -7655,7 +7643,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7655
7643
|
* @param {ScheduleGroupCreateRequest} scheduleGroupCreateRequest
|
|
7656
7644
|
* @param {*} [options] Override http request option.
|
|
7657
7645
|
* @throws {RequiredError}
|
|
7658
|
-
* @memberof
|
|
7646
|
+
* @memberof Scout9Api
|
|
7659
7647
|
*/
|
|
7660
7648
|
scheduleGroupCreate(scheduleGroupCreateRequest: ScheduleGroupCreateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupCreateResponse, any>>;
|
|
7661
7649
|
/**
|
|
@@ -7664,7 +7652,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7664
7652
|
* @param {string} id id of entity to query
|
|
7665
7653
|
* @param {*} [options] Override http request option.
|
|
7666
7654
|
* @throws {RequiredError}
|
|
7667
|
-
* @memberof
|
|
7655
|
+
* @memberof Scout9Api
|
|
7668
7656
|
*/
|
|
7669
7657
|
scheduleGroupDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupRemoveResponse, any>>;
|
|
7670
7658
|
/**
|
|
@@ -7673,7 +7661,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7673
7661
|
* @param {string} id id of entity to query
|
|
7674
7662
|
* @param {*} [options] Override http request option.
|
|
7675
7663
|
* @throws {RequiredError}
|
|
7676
|
-
* @memberof
|
|
7664
|
+
* @memberof Scout9Api
|
|
7677
7665
|
*/
|
|
7678
7666
|
scheduleGroupRetrieve(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupGetResponse, any>>;
|
|
7679
7667
|
/**
|
|
@@ -7682,7 +7670,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7682
7670
|
* @param {ScheduleGroupUpdateRequest} scheduleGroupUpdateRequest
|
|
7683
7671
|
* @param {*} [options] Override http request option.
|
|
7684
7672
|
* @throws {RequiredError}
|
|
7685
|
-
* @memberof
|
|
7673
|
+
* @memberof Scout9Api
|
|
7686
7674
|
*/
|
|
7687
7675
|
scheduleGroupUpdate(scheduleGroupUpdateRequest: ScheduleGroupUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleGroupUpdateResponse, any>>;
|
|
7688
7676
|
/**
|
|
@@ -7691,7 +7679,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7691
7679
|
* @param {string} id id of entity to query
|
|
7692
7680
|
* @param {*} [options] Override http request option.
|
|
7693
7681
|
* @throws {RequiredError}
|
|
7694
|
-
* @memberof
|
|
7682
|
+
* @memberof Scout9Api
|
|
7695
7683
|
*/
|
|
7696
7684
|
scheduleRetrieve(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleCreateResponse, any>>;
|
|
7697
7685
|
/**
|
|
@@ -7700,7 +7688,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7700
7688
|
* @param {ScheduleUpdateRequest} scheduleUpdateRequest
|
|
7701
7689
|
* @param {*} [options] Override http request option.
|
|
7702
7690
|
* @throws {RequiredError}
|
|
7703
|
-
* @memberof
|
|
7691
|
+
* @memberof Scout9Api
|
|
7704
7692
|
*/
|
|
7705
7693
|
scheduleUpdate(scheduleUpdateRequest: ScheduleUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScheduleUpdateResponse, any>>;
|
|
7706
7694
|
/**
|
|
@@ -7709,7 +7697,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7709
7697
|
* @param {string} id id of entity to query
|
|
7710
7698
|
* @param {*} [options] Override http request option.
|
|
7711
7699
|
* @throws {RequiredError}
|
|
7712
|
-
* @memberof
|
|
7700
|
+
* @memberof Scout9Api
|
|
7713
7701
|
*/
|
|
7714
7702
|
workflow(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetWorkflowResponse, any>>;
|
|
7715
7703
|
/**
|
|
@@ -7718,7 +7706,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7718
7706
|
* @param {CreateWorkflowRequest} createWorkflowRequest
|
|
7719
7707
|
* @param {*} [options] Override http request option.
|
|
7720
7708
|
* @throws {RequiredError}
|
|
7721
|
-
* @memberof
|
|
7709
|
+
* @memberof Scout9Api
|
|
7722
7710
|
*/
|
|
7723
7711
|
workflowCreate(createWorkflowRequest: CreateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflowResponse, any>>;
|
|
7724
7712
|
/**
|
|
@@ -7727,7 +7715,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7727
7715
|
* @param {string} id id of entity to query
|
|
7728
7716
|
* @param {*} [options] Override http request option.
|
|
7729
7717
|
* @throws {RequiredError}
|
|
7730
|
-
* @memberof
|
|
7718
|
+
* @memberof Scout9Api
|
|
7731
7719
|
*/
|
|
7732
7720
|
workflowDelete(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflowResponse, any>>;
|
|
7733
7721
|
/**
|
|
@@ -7736,7 +7724,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7736
7724
|
* @param {UpdateWorkflowRequest} updateWorkflowRequest
|
|
7737
7725
|
* @param {*} [options] Override http request option.
|
|
7738
7726
|
* @throws {RequiredError}
|
|
7739
|
-
* @memberof
|
|
7727
|
+
* @memberof Scout9Api
|
|
7740
7728
|
*/
|
|
7741
7729
|
workflowUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkflowResponse, any>>;
|
|
7742
7730
|
/**
|
|
@@ -7746,7 +7734,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7746
7734
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7747
7735
|
* @param {*} [options] Override http request option.
|
|
7748
7736
|
* @throws {RequiredError}
|
|
7749
|
-
* @memberof
|
|
7737
|
+
* @memberof Scout9Api
|
|
7750
7738
|
*/
|
|
7751
7739
|
workflows(q?: string, id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflowsResponseInner[], any>>;
|
|
7752
7740
|
/**
|
|
@@ -7755,7 +7743,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7755
7743
|
* @param {CreateWorkflowsRequest} createWorkflowsRequest
|
|
7756
7744
|
* @param {*} [options] Override http request option.
|
|
7757
7745
|
* @throws {RequiredError}
|
|
7758
|
-
* @memberof
|
|
7746
|
+
* @memberof Scout9Api
|
|
7759
7747
|
*/
|
|
7760
7748
|
workflowsCreate(createWorkflowsRequest: CreateWorkflowsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflowsResponse, any>>;
|
|
7761
7749
|
/**
|
|
@@ -7764,7 +7752,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7764
7752
|
* @param {Array<string>} [id] ids for the entities this id belongs to
|
|
7765
7753
|
* @param {*} [options] Override http request option.
|
|
7766
7754
|
* @throws {RequiredError}
|
|
7767
|
-
* @memberof
|
|
7755
|
+
* @memberof Scout9Api
|
|
7768
7756
|
*/
|
|
7769
7757
|
workflowsDelete(id?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflowsResponse, any>>;
|
|
7770
7758
|
/**
|
|
@@ -7773,7 +7761,7 @@ export declare class PocketScoutApi extends BaseAPI {
|
|
|
7773
7761
|
* @param {UpdateWorkflowRequest} updateWorkflowRequest
|
|
7774
7762
|
* @param {*} [options] Override http request option.
|
|
7775
7763
|
* @throws {RequiredError}
|
|
7776
|
-
* @memberof
|
|
7764
|
+
* @memberof Scout9Api
|
|
7777
7765
|
*/
|
|
7778
7766
|
workflowsUpdate(updateWorkflowRequest: UpdateWorkflowRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateWorkflowsResponse, any>>;
|
|
7779
7767
|
}
|