@scout9/admin 1.0.0-alpha.0.0.31 → 1.0.0-alpha.0.0.32
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/build/api.d.ts +223 -249
- package/build/api.js +447 -485
- package/package.json +1 -1
- package/src/api.ts +468 -507
- package/tsconfig.tsbuildinfo +1 -1
package/build/api.d.ts
CHANGED
|
@@ -6917,266 +6917,20 @@ export declare class CustomContextApi extends BaseAPI {
|
|
|
6917
6917
|
contextTest(contextTestRequest: ContextTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ContextTestResponse, any>>;
|
|
6918
6918
|
}
|
|
6919
6919
|
/**
|
|
6920
|
-
*
|
|
6921
|
-
* @export
|
|
6922
|
-
*/
|
|
6923
|
-
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6924
|
-
/**
|
|
6925
|
-
* Creates a new entity with the specified type and ID.
|
|
6926
|
-
* @summary Create a new entity
|
|
6927
|
-
* @param {string} type
|
|
6928
|
-
* @param {string} id The unique identifier of the entity
|
|
6929
|
-
* @param {EntityData} entityData
|
|
6930
|
-
* @param {*} [options] Override http request option.
|
|
6931
|
-
* @throws {RequiredError}
|
|
6932
|
-
*/
|
|
6933
|
-
addEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6934
|
-
/**
|
|
6935
|
-
* Deletes an entity with the specified type and ID.
|
|
6936
|
-
* @summary Delete an entity
|
|
6937
|
-
* @param {string} type
|
|
6938
|
-
* @param {string} id
|
|
6939
|
-
* @param {*} [options] Override http request option.
|
|
6940
|
-
* @throws {RequiredError}
|
|
6941
|
-
*/
|
|
6942
|
-
deleteEntity: (type: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6943
|
-
/**
|
|
6944
|
-
* Fetches a single entity based on its type and ID.
|
|
6945
|
-
* @summary Get an entity by type and ID
|
|
6946
|
-
* @param {string} type The type of the entity to fetch
|
|
6947
|
-
* @param {string} id The unique identifier of the entity
|
|
6948
|
-
* @param {*} [options] Override http request option.
|
|
6949
|
-
* @throws {RequiredError}
|
|
6950
|
-
*/
|
|
6951
|
-
entity: (type: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6952
|
-
/**
|
|
6953
|
-
*
|
|
6954
|
-
* @summary This is used for the generator to incldue PurposeEnum, because for whatever reason, query params are not included in the generator.
|
|
6955
|
-
* @param {PingRequest} pingRequest
|
|
6956
|
-
* @param {*} [options] Override http request option.
|
|
6957
|
-
* @throws {RequiredError}
|
|
6958
|
-
*/
|
|
6959
|
-
ping: (pingRequest: PingRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6960
|
-
/**
|
|
6961
|
-
* Replaces an existing entity with the specified type and ID with a new entity.
|
|
6962
|
-
* @summary Replace an existing entity
|
|
6963
|
-
* @param {string} type
|
|
6964
|
-
* @param {string} id
|
|
6965
|
-
* @param {EntityData} entityData
|
|
6966
|
-
* @param {*} [options] Override http request option.
|
|
6967
|
-
* @throws {RequiredError}
|
|
6968
|
-
*/
|
|
6969
|
-
replaceEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6970
|
-
/**
|
|
6971
|
-
* Updates an existing entity with the specified type and ID.
|
|
6972
|
-
* @summary Update an existing entity
|
|
6973
|
-
* @param {string} type
|
|
6974
|
-
* @param {string} id
|
|
6975
|
-
* @param {EntityData} entityData
|
|
6976
|
-
* @param {*} [options] Override http request option.
|
|
6977
|
-
* @throws {RequiredError}
|
|
6978
|
-
*/
|
|
6979
|
-
updateEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
6980
|
-
};
|
|
6981
|
-
/**
|
|
6982
|
-
* DefaultApi - functional programming interface
|
|
6983
|
-
* @export
|
|
6984
|
-
*/
|
|
6985
|
-
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
6986
|
-
/**
|
|
6987
|
-
* Creates a new entity with the specified type and ID.
|
|
6988
|
-
* @summary Create a new entity
|
|
6989
|
-
* @param {string} type
|
|
6990
|
-
* @param {string} id The unique identifier of the entity
|
|
6991
|
-
* @param {EntityData} entityData
|
|
6992
|
-
* @param {*} [options] Override http request option.
|
|
6993
|
-
* @throws {RequiredError}
|
|
6994
|
-
*/
|
|
6995
|
-
addEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
|
|
6996
|
-
/**
|
|
6997
|
-
* Deletes an entity with the specified type and ID.
|
|
6998
|
-
* @summary Delete an entity
|
|
6999
|
-
* @param {string} type
|
|
7000
|
-
* @param {string} id
|
|
7001
|
-
* @param {*} [options] Override http request option.
|
|
7002
|
-
* @throws {RequiredError}
|
|
7003
|
-
*/
|
|
7004
|
-
deleteEntity(type: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7005
|
-
/**
|
|
7006
|
-
* Fetches a single entity based on its type and ID.
|
|
7007
|
-
* @summary Get an entity by type and ID
|
|
7008
|
-
* @param {string} type The type of the entity to fetch
|
|
7009
|
-
* @param {string} id The unique identifier of the entity
|
|
7010
|
-
* @param {*} [options] Override http request option.
|
|
7011
|
-
* @throws {RequiredError}
|
|
7012
|
-
*/
|
|
7013
|
-
entity(type: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
|
|
7014
|
-
/**
|
|
7015
|
-
*
|
|
7016
|
-
* @summary This is used for the generator to incldue PurposeEnum, because for whatever reason, query params are not included in the generator.
|
|
7017
|
-
* @param {PingRequest} pingRequest
|
|
7018
|
-
* @param {*} [options] Override http request option.
|
|
7019
|
-
* @throws {RequiredError}
|
|
7020
|
-
*/
|
|
7021
|
-
ping(pingRequest: PingRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PingRequest>>;
|
|
7022
|
-
/**
|
|
7023
|
-
* Replaces an existing entity with the specified type and ID with a new entity.
|
|
7024
|
-
* @summary Replace an existing entity
|
|
7025
|
-
* @param {string} type
|
|
7026
|
-
* @param {string} id
|
|
7027
|
-
* @param {EntityData} entityData
|
|
7028
|
-
* @param {*} [options] Override http request option.
|
|
7029
|
-
* @throws {RequiredError}
|
|
7030
|
-
*/
|
|
7031
|
-
replaceEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
|
|
7032
|
-
/**
|
|
7033
|
-
* Updates an existing entity with the specified type and ID.
|
|
7034
|
-
* @summary Update an existing entity
|
|
7035
|
-
* @param {string} type
|
|
7036
|
-
* @param {string} id
|
|
7037
|
-
* @param {EntityData} entityData
|
|
7038
|
-
* @param {*} [options] Override http request option.
|
|
7039
|
-
* @throws {RequiredError}
|
|
7040
|
-
*/
|
|
7041
|
-
updateEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
|
|
7042
|
-
};
|
|
7043
|
-
/**
|
|
7044
|
-
* DefaultApi - factory interface
|
|
6920
|
+
* Scout9Api - axios parameter creator
|
|
7045
6921
|
* @export
|
|
7046
6922
|
*/
|
|
7047
|
-
export declare const
|
|
7048
|
-
/**
|
|
7049
|
-
* Creates a new entity with the specified type and ID.
|
|
7050
|
-
* @summary Create a new entity
|
|
7051
|
-
* @param {string} type
|
|
7052
|
-
* @param {string} id The unique identifier of the entity
|
|
7053
|
-
* @param {EntityData} entityData
|
|
7054
|
-
* @param {*} [options] Override http request option.
|
|
7055
|
-
* @throws {RequiredError}
|
|
7056
|
-
*/
|
|
7057
|
-
addEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
|
|
7058
|
-
/**
|
|
7059
|
-
* Deletes an entity with the specified type and ID.
|
|
7060
|
-
* @summary Delete an entity
|
|
7061
|
-
* @param {string} type
|
|
7062
|
-
* @param {string} id
|
|
7063
|
-
* @param {*} [options] Override http request option.
|
|
7064
|
-
* @throws {RequiredError}
|
|
7065
|
-
*/
|
|
7066
|
-
deleteEntity(type: string, id: string, options?: any): AxiosPromise<void>;
|
|
7067
|
-
/**
|
|
7068
|
-
* Fetches a single entity based on its type and ID.
|
|
7069
|
-
* @summary Get an entity by type and ID
|
|
7070
|
-
* @param {string} type The type of the entity to fetch
|
|
7071
|
-
* @param {string} id The unique identifier of the entity
|
|
7072
|
-
* @param {*} [options] Override http request option.
|
|
7073
|
-
* @throws {RequiredError}
|
|
7074
|
-
*/
|
|
7075
|
-
entity(type: string, id: string, options?: any): AxiosPromise<Entity>;
|
|
6923
|
+
export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
7076
6924
|
/**
|
|
7077
6925
|
*
|
|
7078
|
-
* @summary This is used for the generator to incldue PurposeEnum, because for whatever reason, query params are not included in the generator.
|
|
7079
|
-
* @param {PingRequest} pingRequest
|
|
7080
|
-
* @param {*} [options] Override http request option.
|
|
7081
|
-
* @throws {RequiredError}
|
|
7082
|
-
*/
|
|
7083
|
-
ping(pingRequest: PingRequest, options?: any): AxiosPromise<PingRequest>;
|
|
7084
|
-
/**
|
|
7085
|
-
* Replaces an existing entity with the specified type and ID with a new entity.
|
|
7086
|
-
* @summary Replace an existing entity
|
|
7087
|
-
* @param {string} type
|
|
7088
|
-
* @param {string} id
|
|
7089
|
-
* @param {EntityData} entityData
|
|
7090
|
-
* @param {*} [options] Override http request option.
|
|
7091
|
-
* @throws {RequiredError}
|
|
7092
|
-
*/
|
|
7093
|
-
replaceEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
|
|
7094
|
-
/**
|
|
7095
|
-
* Updates an existing entity with the specified type and ID.
|
|
7096
|
-
* @summary Update an existing entity
|
|
7097
|
-
* @param {string} type
|
|
7098
|
-
* @param {string} id
|
|
7099
|
-
* @param {EntityData} entityData
|
|
7100
|
-
* @param {*} [options] Override http request option.
|
|
7101
|
-
* @throws {RequiredError}
|
|
7102
|
-
*/
|
|
7103
|
-
updateEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
|
|
7104
|
-
};
|
|
7105
|
-
/**
|
|
7106
|
-
* DefaultApi - object-oriented interface
|
|
7107
|
-
* @export
|
|
7108
|
-
* @class DefaultApi
|
|
7109
|
-
* @extends {BaseAPI}
|
|
7110
|
-
*/
|
|
7111
|
-
export declare class DefaultApi extends BaseAPI {
|
|
7112
|
-
/**
|
|
7113
|
-
* Creates a new entity with the specified type and ID.
|
|
7114
6926
|
* @summary Create a new entity
|
|
7115
6927
|
* @param {string} type
|
|
7116
6928
|
* @param {string} id The unique identifier of the entity
|
|
7117
6929
|
* @param {EntityData} entityData
|
|
7118
6930
|
* @param {*} [options] Override http request option.
|
|
7119
6931
|
* @throws {RequiredError}
|
|
7120
|
-
* @memberof DefaultApi
|
|
7121
|
-
*/
|
|
7122
|
-
addEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
|
|
7123
|
-
/**
|
|
7124
|
-
* Deletes an entity with the specified type and ID.
|
|
7125
|
-
* @summary Delete an entity
|
|
7126
|
-
* @param {string} type
|
|
7127
|
-
* @param {string} id
|
|
7128
|
-
* @param {*} [options] Override http request option.
|
|
7129
|
-
* @throws {RequiredError}
|
|
7130
|
-
* @memberof DefaultApi
|
|
7131
|
-
*/
|
|
7132
|
-
deleteEntity(type: string, id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
7133
|
-
/**
|
|
7134
|
-
* Fetches a single entity based on its type and ID.
|
|
7135
|
-
* @summary Get an entity by type and ID
|
|
7136
|
-
* @param {string} type The type of the entity to fetch
|
|
7137
|
-
* @param {string} id The unique identifier of the entity
|
|
7138
|
-
* @param {*} [options] Override http request option.
|
|
7139
|
-
* @throws {RequiredError}
|
|
7140
|
-
* @memberof DefaultApi
|
|
7141
6932
|
*/
|
|
7142
|
-
|
|
7143
|
-
/**
|
|
7144
|
-
*
|
|
7145
|
-
* @summary This is used for the generator to incldue PurposeEnum, because for whatever reason, query params are not included in the generator.
|
|
7146
|
-
* @param {PingRequest} pingRequest
|
|
7147
|
-
* @param {*} [options] Override http request option.
|
|
7148
|
-
* @throws {RequiredError}
|
|
7149
|
-
* @memberof DefaultApi
|
|
7150
|
-
*/
|
|
7151
|
-
ping(pingRequest: PingRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PingRequest, any>>;
|
|
7152
|
-
/**
|
|
7153
|
-
* Replaces an existing entity with the specified type and ID with a new entity.
|
|
7154
|
-
* @summary Replace an existing entity
|
|
7155
|
-
* @param {string} type
|
|
7156
|
-
* @param {string} id
|
|
7157
|
-
* @param {EntityData} entityData
|
|
7158
|
-
* @param {*} [options] Override http request option.
|
|
7159
|
-
* @throws {RequiredError}
|
|
7160
|
-
* @memberof DefaultApi
|
|
7161
|
-
*/
|
|
7162
|
-
replaceEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
|
|
7163
|
-
/**
|
|
7164
|
-
* Updates an existing entity with the specified type and ID.
|
|
7165
|
-
* @summary Update an existing entity
|
|
7166
|
-
* @param {string} type
|
|
7167
|
-
* @param {string} id
|
|
7168
|
-
* @param {EntityData} entityData
|
|
7169
|
-
* @param {*} [options] Override http request option.
|
|
7170
|
-
* @throws {RequiredError}
|
|
7171
|
-
* @memberof DefaultApi
|
|
7172
|
-
*/
|
|
7173
|
-
updateEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
|
|
7174
|
-
}
|
|
7175
|
-
/**
|
|
7176
|
-
* Scout9Api - axios parameter creator
|
|
7177
|
-
* @export
|
|
7178
|
-
*/
|
|
7179
|
-
export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
6933
|
+
addEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7180
6934
|
/**
|
|
7181
6935
|
*
|
|
7182
6936
|
* @summary Gets a agent
|
|
@@ -7526,6 +7280,24 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
7526
7280
|
* @throws {RequiredError}
|
|
7527
7281
|
*/
|
|
7528
7282
|
customersUpdate: (updateCustomersRequest: UpdateCustomersRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7283
|
+
/**
|
|
7284
|
+
* Deletes an entity with the specified type and ID.
|
|
7285
|
+
* @summary Delete an entity
|
|
7286
|
+
* @param {string} type
|
|
7287
|
+
* @param {string} id
|
|
7288
|
+
* @param {*} [options] Override http request option.
|
|
7289
|
+
* @throws {RequiredError}
|
|
7290
|
+
*/
|
|
7291
|
+
deleteEntity: (type: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7292
|
+
/**
|
|
7293
|
+
*
|
|
7294
|
+
* @summary Get an entity by type and ID
|
|
7295
|
+
* @param {string} type The type of the entity to fetch
|
|
7296
|
+
* @param {string} id The unique identifier of the entity
|
|
7297
|
+
* @param {*} [options] Override http request option.
|
|
7298
|
+
* @throws {RequiredError}
|
|
7299
|
+
*/
|
|
7300
|
+
entity: (type: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7529
7301
|
/**
|
|
7530
7302
|
*
|
|
7531
7303
|
* @summary Returns a file
|
|
@@ -7625,6 +7397,14 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
7625
7397
|
* @throws {RequiredError}
|
|
7626
7398
|
*/
|
|
7627
7399
|
parse: (parseRequest: ParseRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7400
|
+
/**
|
|
7401
|
+
*
|
|
7402
|
+
* @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
|
|
7403
|
+
* @param {PingRequest} pingRequest
|
|
7404
|
+
* @param {*} [options] Override http request option.
|
|
7405
|
+
* @throws {RequiredError}
|
|
7406
|
+
*/
|
|
7407
|
+
ping: (pingRequest: PingRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7628
7408
|
/**
|
|
7629
7409
|
*
|
|
7630
7410
|
* @summary Purchase phone for a given agent.
|
|
@@ -7633,6 +7413,16 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
7633
7413
|
* @throws {RequiredError}
|
|
7634
7414
|
*/
|
|
7635
7415
|
purchasePhone: (purchasePhoneRequest?: PurchasePhoneRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7416
|
+
/**
|
|
7417
|
+
* Replaces an existing entity with the specified type and ID with a new entity.
|
|
7418
|
+
* @summary Replace an existing entity
|
|
7419
|
+
* @param {string} type
|
|
7420
|
+
* @param {string} id
|
|
7421
|
+
* @param {EntityData} entityData
|
|
7422
|
+
* @param {*} [options] Override http request option.
|
|
7423
|
+
* @throws {RequiredError}
|
|
7424
|
+
*/
|
|
7425
|
+
replaceEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7636
7426
|
/**
|
|
7637
7427
|
*
|
|
7638
7428
|
* @summary Runs your auto-reply app on the Scout9 platform.
|
|
@@ -7648,12 +7438,32 @@ export declare const Scout9ApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
7648
7438
|
* @throws {RequiredError}
|
|
7649
7439
|
*/
|
|
7650
7440
|
runPlatformConfig: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7441
|
+
/**
|
|
7442
|
+
* Updates an existing entity with the specified type and ID.
|
|
7443
|
+
* @summary Update an existing entity
|
|
7444
|
+
* @param {string} type
|
|
7445
|
+
* @param {string} id
|
|
7446
|
+
* @param {EntityData} entityData
|
|
7447
|
+
* @param {*} [options] Override http request option.
|
|
7448
|
+
* @throws {RequiredError}
|
|
7449
|
+
*/
|
|
7450
|
+
updateEntity: (type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7651
7451
|
};
|
|
7652
7452
|
/**
|
|
7653
7453
|
* Scout9Api - functional programming interface
|
|
7654
7454
|
* @export
|
|
7655
7455
|
*/
|
|
7656
7456
|
export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
7457
|
+
/**
|
|
7458
|
+
*
|
|
7459
|
+
* @summary Create a new entity
|
|
7460
|
+
* @param {string} type
|
|
7461
|
+
* @param {string} id The unique identifier of the entity
|
|
7462
|
+
* @param {EntityData} entityData
|
|
7463
|
+
* @param {*} [options] Override http request option.
|
|
7464
|
+
* @throws {RequiredError}
|
|
7465
|
+
*/
|
|
7466
|
+
addEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
|
|
7657
7467
|
/**
|
|
7658
7468
|
*
|
|
7659
7469
|
* @summary Gets a agent
|
|
@@ -8003,6 +7813,24 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
8003
7813
|
* @throws {RequiredError}
|
|
8004
7814
|
*/
|
|
8005
7815
|
customersUpdate(updateCustomersRequest: UpdateCustomersRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomersResponse>>;
|
|
7816
|
+
/**
|
|
7817
|
+
* Deletes an entity with the specified type and ID.
|
|
7818
|
+
* @summary Delete an entity
|
|
7819
|
+
* @param {string} type
|
|
7820
|
+
* @param {string} id
|
|
7821
|
+
* @param {*} [options] Override http request option.
|
|
7822
|
+
* @throws {RequiredError}
|
|
7823
|
+
*/
|
|
7824
|
+
deleteEntity(type: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
7825
|
+
/**
|
|
7826
|
+
*
|
|
7827
|
+
* @summary Get an entity by type and ID
|
|
7828
|
+
* @param {string} type The type of the entity to fetch
|
|
7829
|
+
* @param {string} id The unique identifier of the entity
|
|
7830
|
+
* @param {*} [options] Override http request option.
|
|
7831
|
+
* @throws {RequiredError}
|
|
7832
|
+
*/
|
|
7833
|
+
entity(type: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
|
|
8006
7834
|
/**
|
|
8007
7835
|
*
|
|
8008
7836
|
* @summary Returns a file
|
|
@@ -8102,6 +7930,14 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
8102
7930
|
* @throws {RequiredError}
|
|
8103
7931
|
*/
|
|
8104
7932
|
parse(parseRequest: ParseRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParseResponse>>;
|
|
7933
|
+
/**
|
|
7934
|
+
*
|
|
7935
|
+
* @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
|
|
7936
|
+
* @param {PingRequest} pingRequest
|
|
7937
|
+
* @param {*} [options] Override http request option.
|
|
7938
|
+
* @throws {RequiredError}
|
|
7939
|
+
*/
|
|
7940
|
+
ping(pingRequest: PingRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PingRequest>>;
|
|
8105
7941
|
/**
|
|
8106
7942
|
*
|
|
8107
7943
|
* @summary Purchase phone for a given agent.
|
|
@@ -8110,6 +7946,16 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
8110
7946
|
* @throws {RequiredError}
|
|
8111
7947
|
*/
|
|
8112
7948
|
purchasePhone(purchasePhoneRequest?: PurchasePhoneRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PurchasePhoneResponse>>;
|
|
7949
|
+
/**
|
|
7950
|
+
* Replaces an existing entity with the specified type and ID with a new entity.
|
|
7951
|
+
* @summary Replace an existing entity
|
|
7952
|
+
* @param {string} type
|
|
7953
|
+
* @param {string} id
|
|
7954
|
+
* @param {EntityData} entityData
|
|
7955
|
+
* @param {*} [options] Override http request option.
|
|
7956
|
+
* @throws {RequiredError}
|
|
7957
|
+
*/
|
|
7958
|
+
replaceEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
|
|
8113
7959
|
/**
|
|
8114
7960
|
*
|
|
8115
7961
|
* @summary Runs your auto-reply app on the Scout9 platform.
|
|
@@ -8127,12 +7973,32 @@ export declare const Scout9ApiFp: (configuration?: Configuration) => {
|
|
|
8127
7973
|
runPlatformConfig(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
8128
7974
|
[key: string]: any;
|
|
8129
7975
|
}>>;
|
|
7976
|
+
/**
|
|
7977
|
+
* Updates an existing entity with the specified type and ID.
|
|
7978
|
+
* @summary Update an existing entity
|
|
7979
|
+
* @param {string} type
|
|
7980
|
+
* @param {string} id
|
|
7981
|
+
* @param {EntityData} entityData
|
|
7982
|
+
* @param {*} [options] Override http request option.
|
|
7983
|
+
* @throws {RequiredError}
|
|
7984
|
+
*/
|
|
7985
|
+
updateEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entity>>;
|
|
8130
7986
|
};
|
|
8131
7987
|
/**
|
|
8132
7988
|
* Scout9Api - factory interface
|
|
8133
7989
|
* @export
|
|
8134
7990
|
*/
|
|
8135
7991
|
export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
7992
|
+
/**
|
|
7993
|
+
*
|
|
7994
|
+
* @summary Create a new entity
|
|
7995
|
+
* @param {string} type
|
|
7996
|
+
* @param {string} id The unique identifier of the entity
|
|
7997
|
+
* @param {EntityData} entityData
|
|
7998
|
+
* @param {*} [options] Override http request option.
|
|
7999
|
+
* @throws {RequiredError}
|
|
8000
|
+
*/
|
|
8001
|
+
addEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
|
|
8136
8002
|
/**
|
|
8137
8003
|
*
|
|
8138
8004
|
* @summary Gets a agent
|
|
@@ -8482,6 +8348,24 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
8482
8348
|
* @throws {RequiredError}
|
|
8483
8349
|
*/
|
|
8484
8350
|
customersUpdate(updateCustomersRequest: UpdateCustomersRequest, options?: any): AxiosPromise<UpdateCustomersResponse>;
|
|
8351
|
+
/**
|
|
8352
|
+
* Deletes an entity with the specified type and ID.
|
|
8353
|
+
* @summary Delete an entity
|
|
8354
|
+
* @param {string} type
|
|
8355
|
+
* @param {string} id
|
|
8356
|
+
* @param {*} [options] Override http request option.
|
|
8357
|
+
* @throws {RequiredError}
|
|
8358
|
+
*/
|
|
8359
|
+
deleteEntity(type: string, id: string, options?: any): AxiosPromise<void>;
|
|
8360
|
+
/**
|
|
8361
|
+
*
|
|
8362
|
+
* @summary Get an entity by type and ID
|
|
8363
|
+
* @param {string} type The type of the entity to fetch
|
|
8364
|
+
* @param {string} id The unique identifier of the entity
|
|
8365
|
+
* @param {*} [options] Override http request option.
|
|
8366
|
+
* @throws {RequiredError}
|
|
8367
|
+
*/
|
|
8368
|
+
entity(type: string, id: string, options?: any): AxiosPromise<Entity>;
|
|
8485
8369
|
/**
|
|
8486
8370
|
*
|
|
8487
8371
|
* @summary Returns a file
|
|
@@ -8581,6 +8465,14 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
8581
8465
|
* @throws {RequiredError}
|
|
8582
8466
|
*/
|
|
8583
8467
|
parse(parseRequest: ParseRequest, options?: any): AxiosPromise<ParseResponse>;
|
|
8468
|
+
/**
|
|
8469
|
+
*
|
|
8470
|
+
* @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
|
|
8471
|
+
* @param {PingRequest} pingRequest
|
|
8472
|
+
* @param {*} [options] Override http request option.
|
|
8473
|
+
* @throws {RequiredError}
|
|
8474
|
+
*/
|
|
8475
|
+
ping(pingRequest: PingRequest, options?: any): AxiosPromise<PingRequest>;
|
|
8584
8476
|
/**
|
|
8585
8477
|
*
|
|
8586
8478
|
* @summary Purchase phone for a given agent.
|
|
@@ -8589,6 +8481,16 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
8589
8481
|
* @throws {RequiredError}
|
|
8590
8482
|
*/
|
|
8591
8483
|
purchasePhone(purchasePhoneRequest?: PurchasePhoneRequest, options?: any): AxiosPromise<PurchasePhoneResponse>;
|
|
8484
|
+
/**
|
|
8485
|
+
* Replaces an existing entity with the specified type and ID with a new entity.
|
|
8486
|
+
* @summary Replace an existing entity
|
|
8487
|
+
* @param {string} type
|
|
8488
|
+
* @param {string} id
|
|
8489
|
+
* @param {EntityData} entityData
|
|
8490
|
+
* @param {*} [options] Override http request option.
|
|
8491
|
+
* @throws {RequiredError}
|
|
8492
|
+
*/
|
|
8493
|
+
replaceEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
|
|
8592
8494
|
/**
|
|
8593
8495
|
*
|
|
8594
8496
|
* @summary Runs your auto-reply app on the Scout9 platform.
|
|
@@ -8606,6 +8508,16 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
8606
8508
|
runPlatformConfig(options?: any): AxiosPromise<{
|
|
8607
8509
|
[key: string]: any;
|
|
8608
8510
|
}>;
|
|
8511
|
+
/**
|
|
8512
|
+
* Updates an existing entity with the specified type and ID.
|
|
8513
|
+
* @summary Update an existing entity
|
|
8514
|
+
* @param {string} type
|
|
8515
|
+
* @param {string} id
|
|
8516
|
+
* @param {EntityData} entityData
|
|
8517
|
+
* @param {*} [options] Override http request option.
|
|
8518
|
+
* @throws {RequiredError}
|
|
8519
|
+
*/
|
|
8520
|
+
updateEntity(type: string, id: string, entityData: EntityData, options?: any): AxiosPromise<Entity>;
|
|
8609
8521
|
};
|
|
8610
8522
|
/**
|
|
8611
8523
|
* Scout9Api - object-oriented interface
|
|
@@ -8614,6 +8526,17 @@ export declare const Scout9ApiFactory: (configuration?: Configuration, basePath?
|
|
|
8614
8526
|
* @extends {BaseAPI}
|
|
8615
8527
|
*/
|
|
8616
8528
|
export declare class Scout9Api extends BaseAPI {
|
|
8529
|
+
/**
|
|
8530
|
+
*
|
|
8531
|
+
* @summary Create a new entity
|
|
8532
|
+
* @param {string} type
|
|
8533
|
+
* @param {string} id The unique identifier of the entity
|
|
8534
|
+
* @param {EntityData} entityData
|
|
8535
|
+
* @param {*} [options] Override http request option.
|
|
8536
|
+
* @throws {RequiredError}
|
|
8537
|
+
* @memberof Scout9Api
|
|
8538
|
+
*/
|
|
8539
|
+
addEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
|
|
8617
8540
|
/**
|
|
8618
8541
|
*
|
|
8619
8542
|
* @summary Gets a agent
|
|
@@ -9005,6 +8928,26 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
9005
8928
|
* @memberof Scout9Api
|
|
9006
8929
|
*/
|
|
9007
8930
|
customersUpdate(updateCustomersRequest: UpdateCustomersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomersResponse, any>>;
|
|
8931
|
+
/**
|
|
8932
|
+
* Deletes an entity with the specified type and ID.
|
|
8933
|
+
* @summary Delete an entity
|
|
8934
|
+
* @param {string} type
|
|
8935
|
+
* @param {string} id
|
|
8936
|
+
* @param {*} [options] Override http request option.
|
|
8937
|
+
* @throws {RequiredError}
|
|
8938
|
+
* @memberof Scout9Api
|
|
8939
|
+
*/
|
|
8940
|
+
deleteEntity(type: string, id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
8941
|
+
/**
|
|
8942
|
+
*
|
|
8943
|
+
* @summary Get an entity by type and ID
|
|
8944
|
+
* @param {string} type The type of the entity to fetch
|
|
8945
|
+
* @param {string} id The unique identifier of the entity
|
|
8946
|
+
* @param {*} [options] Override http request option.
|
|
8947
|
+
* @throws {RequiredError}
|
|
8948
|
+
* @memberof Scout9Api
|
|
8949
|
+
*/
|
|
8950
|
+
entity(type: string, id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
|
|
9008
8951
|
/**
|
|
9009
8952
|
*
|
|
9010
8953
|
* @summary Returns a file
|
|
@@ -9115,6 +9058,15 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
9115
9058
|
* @memberof Scout9Api
|
|
9116
9059
|
*/
|
|
9117
9060
|
parse(parseRequest: ParseRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ParseResponse, any>>;
|
|
9061
|
+
/**
|
|
9062
|
+
*
|
|
9063
|
+
* @summary This is used for the generator to include PurposeEnum, because for whatever reason, query params are not included in the generator.
|
|
9064
|
+
* @param {PingRequest} pingRequest
|
|
9065
|
+
* @param {*} [options] Override http request option.
|
|
9066
|
+
* @throws {RequiredError}
|
|
9067
|
+
* @memberof Scout9Api
|
|
9068
|
+
*/
|
|
9069
|
+
ping(pingRequest: PingRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PingRequest, any>>;
|
|
9118
9070
|
/**
|
|
9119
9071
|
*
|
|
9120
9072
|
* @summary Purchase phone for a given agent.
|
|
@@ -9124,6 +9076,17 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
9124
9076
|
* @memberof Scout9Api
|
|
9125
9077
|
*/
|
|
9126
9078
|
purchasePhone(purchasePhoneRequest?: PurchasePhoneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PurchasePhoneResponse, any>>;
|
|
9079
|
+
/**
|
|
9080
|
+
* Replaces an existing entity with the specified type and ID with a new entity.
|
|
9081
|
+
* @summary Replace an existing entity
|
|
9082
|
+
* @param {string} type
|
|
9083
|
+
* @param {string} id
|
|
9084
|
+
* @param {EntityData} entityData
|
|
9085
|
+
* @param {*} [options] Override http request option.
|
|
9086
|
+
* @throws {RequiredError}
|
|
9087
|
+
* @memberof Scout9Api
|
|
9088
|
+
*/
|
|
9089
|
+
replaceEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
|
|
9127
9090
|
/**
|
|
9128
9091
|
*
|
|
9129
9092
|
* @summary Runs your auto-reply app on the Scout9 platform.
|
|
@@ -9143,4 +9106,15 @@ export declare class Scout9Api extends BaseAPI {
|
|
|
9143
9106
|
runPlatformConfig(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
9144
9107
|
[key: string]: any;
|
|
9145
9108
|
}, any>>;
|
|
9109
|
+
/**
|
|
9110
|
+
* Updates an existing entity with the specified type and ID.
|
|
9111
|
+
* @summary Update an existing entity
|
|
9112
|
+
* @param {string} type
|
|
9113
|
+
* @param {string} id
|
|
9114
|
+
* @param {EntityData} entityData
|
|
9115
|
+
* @param {*} [options] Override http request option.
|
|
9116
|
+
* @throws {RequiredError}
|
|
9117
|
+
* @memberof Scout9Api
|
|
9118
|
+
*/
|
|
9119
|
+
updateEntity(type: string, id: string, entityData: EntityData, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entity, any>>;
|
|
9146
9120
|
}
|