@botpress/client 0.0.12 → 0.0.13

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/gen/api.d.ts CHANGED
@@ -9,9 +9,10 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { Configuration } from './configuration';
13
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
- import { RequestArgs, BaseAPI } from './base';
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
15
16
  /**
16
17
  *
17
18
  * @export
@@ -3075,10 +3076,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
3075
3076
  /**
3076
3077
  * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
3077
3078
  * @param {string} [nextToken] Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
3079
+ * @param {string} [type] Filter by event type
3078
3080
  * @param {*} [options] Override http request option.
3079
3081
  * @throws {RequiredError}
3080
3082
  */
3081
- listEvents: (nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3083
+ listEvents: (nextToken?: string, type?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3082
3084
  /**
3083
3085
  * List Files
3084
3086
  * @param {string} botId Bot ID
@@ -3488,10 +3490,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3488
3490
  /**
3489
3491
  * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
3490
3492
  * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3493
+ * @param {string} [type] Filter by event type
3491
3494
  * @param {*} [options] Override http request option.
3492
3495
  * @throws {RequiredError}
3493
3496
  */
3494
- listEvents(nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
3497
+ listEvents(nextToken?: string, type?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListEventsResponse>>;
3495
3498
  /**
3496
3499
  * List Files
3497
3500
  * @param {string} botId Bot ID
@@ -3623,879 +3626,376 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
3623
3626
  export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3624
3627
  /**
3625
3628
  * Call an action
3626
- * @param {CallActionBody} [callActionBody] Action payload
3629
+ * @param {DefaultApiCallActionRequest} requestParameters Request parameters.
3627
3630
  * @param {*} [options] Override http request option.
3628
3631
  * @throws {RequiredError}
3629
3632
  */
3630
- callAction(callActionBody?: CallActionBody, options?: any): AxiosPromise<CallActionResponse>;
3633
+ callAction(requestParameters?: DefaultApiCallActionRequest, options?: AxiosRequestConfig): AxiosPromise<CallActionResponse>;
3631
3634
  /**
3632
3635
  * An integration can call this endpoint to configure itself
3633
- * @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
3636
+ * @param {DefaultApiConfigureIntegrationRequest} requestParameters Request parameters.
3634
3637
  * @param {*} [options] Override http request option.
3635
3638
  * @throws {RequiredError}
3636
3639
  */
3637
- configureIntegration(configureIntegrationBody?: ConfigureIntegrationBody, options?: any): AxiosPromise<object>;
3640
+ configureIntegration(requestParameters?: DefaultApiConfigureIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3638
3641
  /**
3639
3642
  * Create bot
3640
- * @param {CreateBotBody} [createBotBody] Bot metadata
3643
+ * @param {DefaultApiCreateBotRequest} requestParameters Request parameters.
3641
3644
  * @param {*} [options] Override http request option.
3642
3645
  * @throws {RequiredError}
3643
3646
  */
3644
- createBot(createBotBody?: CreateBotBody, options?: any): AxiosPromise<CreateBotResponse>;
3647
+ createBot(requestParameters?: DefaultApiCreateBotRequest, options?: AxiosRequestConfig): AxiosPromise<CreateBotResponse>;
3645
3648
  /**
3646
3649
  * Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details.
3647
- * @param {CreateConversationBody} [createConversationBody] Conversation data
3650
+ * @param {DefaultApiCreateConversationRequest} requestParameters Request parameters.
3648
3651
  * @param {*} [options] Override http request option.
3649
3652
  * @throws {RequiredError}
3650
3653
  */
3651
- createConversation(createConversationBody?: CreateConversationBody, options?: any): AxiosPromise<CreateConversationResponse>;
3654
+ createConversation(requestParameters?: DefaultApiCreateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateConversationResponse>;
3652
3655
  /**
3653
3656
  * Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.
3654
- * @param {CreateEventBody} [createEventBody] Event data
3657
+ * @param {DefaultApiCreateEventRequest} requestParameters Request parameters.
3655
3658
  * @param {*} [options] Override http request option.
3656
3659
  * @throws {RequiredError}
3657
3660
  */
3658
- createEvent(createEventBody?: CreateEventBody, options?: any): AxiosPromise<CreateEventResponse>;
3661
+ createEvent(requestParameters?: DefaultApiCreateEventRequest, options?: AxiosRequestConfig): AxiosPromise<CreateEventResponse>;
3659
3662
  /**
3660
3663
  * Create File
3661
- * @param {CreateFileBody} [createFileBody] Create File
3664
+ * @param {DefaultApiCreateFileRequest} requestParameters Request parameters.
3662
3665
  * @param {*} [options] Override http request option.
3663
3666
  * @throws {RequiredError}
3664
3667
  */
3665
- createFile(createFileBody?: CreateFileBody, options?: any): AxiosPromise<CreateFileResponse>;
3668
+ createFile(requestParameters?: DefaultApiCreateFileRequest, options?: AxiosRequestConfig): AxiosPromise<CreateFileResponse>;
3666
3669
  /**
3667
3670
  * Create integration
3668
- * @param {CreateIntegrationBody} [createIntegrationBody] Integration
3671
+ * @param {DefaultApiCreateIntegrationRequest} requestParameters Request parameters.
3669
3672
  * @param {*} [options] Override http request option.
3670
3673
  * @throws {RequiredError}
3671
3674
  */
3672
- createIntegration(createIntegrationBody?: CreateIntegrationBody, options?: any): AxiosPromise<CreateIntegrationResponse>;
3675
+ createIntegration(requestParameters?: DefaultApiCreateIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<CreateIntegrationResponse>;
3673
3676
  /**
3674
3677
  * Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details.
3675
- * @param {CreateMessageBody} [createMessageBody] Message data
3678
+ * @param {DefaultApiCreateMessageRequest} requestParameters Request parameters.
3676
3679
  * @param {*} [options] Override http request option.
3677
3680
  * @throws {RequiredError}
3678
3681
  */
3679
- createMessage(createMessageBody?: CreateMessageBody, options?: any): AxiosPromise<CreateMessageResponse>;
3682
+ createMessage(requestParameters?: DefaultApiCreateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<CreateMessageResponse>;
3680
3683
  /**
3681
3684
  * 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.
3682
- * @param {CreateUserBody} [createUserBody] User data
3685
+ * @param {DefaultApiCreateUserRequest} requestParameters Request parameters.
3683
3686
  * @param {*} [options] Override http request option.
3684
3687
  * @throws {RequiredError}
3685
3688
  */
3686
- createUser(createUserBody?: CreateUserBody, options?: any): AxiosPromise<CreateUserResponse>;
3689
+ createUser(requestParameters?: DefaultApiCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<CreateUserResponse>;
3687
3690
  /**
3688
3691
  * Delete bot
3689
- * @param {string} id Bot ID
3692
+ * @param {DefaultApiDeleteBotRequest} requestParameters Request parameters.
3690
3693
  * @param {*} [options] Override http request option.
3691
3694
  * @throws {RequiredError}
3692
3695
  */
3693
- deleteBot(id: string, options?: any): AxiosPromise<object>;
3696
+ deleteBot(requestParameters: DefaultApiDeleteBotRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3694
3697
  /**
3695
3698
  * Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
3696
- * @param {string} id Conversation id
3699
+ * @param {DefaultApiDeleteConversationRequest} requestParameters Request parameters.
3697
3700
  * @param {*} [options] Override http request option.
3698
3701
  * @throws {RequiredError}
3699
3702
  */
3700
- deleteConversation(id: string, options?: any): AxiosPromise<object>;
3703
+ deleteConversation(requestParameters: DefaultApiDeleteConversationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3701
3704
  /**
3702
3705
  * Delete File
3703
- * @param {string} id File ID
3706
+ * @param {DefaultApiDeleteFileRequest} requestParameters Request parameters.
3704
3707
  * @param {*} [options] Override http request option.
3705
3708
  * @throws {RequiredError}
3706
3709
  */
3707
- deleteFile(id: string, options?: any): AxiosPromise<object>;
3710
+ deleteFile(requestParameters: DefaultApiDeleteFileRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3708
3711
  /**
3709
3712
  * Delete integration
3710
- * @param {string} id Integration Id
3713
+ * @param {DefaultApiDeleteIntegrationRequest} requestParameters Request parameters.
3711
3714
  * @param {*} [options] Override http request option.
3712
3715
  * @throws {RequiredError}
3713
3716
  */
3714
- deleteIntegration(id: string, options?: any): AxiosPromise<object>;
3717
+ deleteIntegration(requestParameters: DefaultApiDeleteIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3715
3718
  /**
3716
3719
  * Permanently deletes a [Message](#schema_message). It cannot be undone.
3717
- * @param {string} id Message id
3720
+ * @param {DefaultApiDeleteMessageRequest} requestParameters Request parameters.
3718
3721
  * @param {*} [options] Override http request option.
3719
3722
  * @throws {RequiredError}
3720
3723
  */
3721
- deleteMessage(id: string, options?: any): AxiosPromise<object>;
3724
+ deleteMessage(requestParameters: DefaultApiDeleteMessageRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3722
3725
  /**
3723
3726
  * Permanently deletes a [User](#schema_user). It cannot be undone.
3724
- * @param {string} id User ID
3727
+ * @param {DefaultApiDeleteUserRequest} requestParameters Request parameters.
3725
3728
  * @param {*} [options] Override http request option.
3726
3729
  * @throws {RequiredError}
3727
3730
  */
3728
- deleteUser(id: string, options?: any): AxiosPromise<object>;
3731
+ deleteUser(requestParameters: DefaultApiDeleteUserRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3729
3732
  /**
3730
3733
  * Download File
3731
- * @param {string} id File ID
3734
+ * @param {DefaultApiDownloadFileRequest} requestParameters Request parameters.
3732
3735
  * @param {*} [options] Override http request option.
3733
3736
  * @throws {RequiredError}
3734
3737
  */
3735
- downloadFile(id: string, options?: any): AxiosPromise<any>;
3738
+ downloadFile(requestParameters: DefaultApiDownloadFileRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
3736
3739
  /**
3737
3740
  * Get bot details
3738
- * @param {string} id Bot ID
3741
+ * @param {DefaultApiGetBotRequest} requestParameters Request parameters.
3739
3742
  * @param {*} [options] Override http request option.
3740
3743
  * @throws {RequiredError}
3741
3744
  */
3742
- getBot(id: string, options?: any): AxiosPromise<GetBotResponse>;
3745
+ getBot(requestParameters: DefaultApiGetBotRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotResponse>;
3743
3746
  /**
3744
3747
  * Get bot analytics
3745
- * @param {string} id Bot ID
3746
- * @param {string} startDate Start date/time (inclusive)
3747
- * @param {string} endDate End date/time (exclusive)
3748
+ * @param {DefaultApiGetBotAnalyticsRequest} requestParameters Request parameters.
3748
3749
  * @param {*} [options] Override http request option.
3749
3750
  * @throws {RequiredError}
3750
3751
  */
3751
- getBotAnalytics(id: string, startDate: string, endDate: string, options?: any): AxiosPromise<GetBotAnalyticsResponse>;
3752
+ getBotAnalytics(requestParameters: DefaultApiGetBotAnalyticsRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotAnalyticsResponse>;
3752
3753
  /**
3753
3754
  * Get bot logs
3754
- * @param {string} id Bot ID
3755
+ * @param {DefaultApiGetBotLogsRequest} requestParameters Request parameters.
3755
3756
  * @param {*} [options] Override http request option.
3756
3757
  * @throws {RequiredError}
3757
3758
  */
3758
- getBotLogs(id: string, options?: any): AxiosPromise<GetBotLogsResponse>;
3759
+ getBotLogs(requestParameters: DefaultApiGetBotLogsRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotLogsResponse>;
3759
3760
  /**
3760
3761
  * Get the webchat code/URL for a bot
3761
- * @param {string} id Bot ID
3762
- * @param {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'} type type of script to get
3762
+ * @param {DefaultApiGetBotWebchatRequest} requestParameters Request parameters.
3763
3763
  * @param {*} [options] Override http request option.
3764
3764
  * @throws {RequiredError}
3765
3765
  */
3766
- getBotWebchat(id: string, type: 'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl', options?: any): AxiosPromise<GetBotWebchatResponse>;
3766
+ getBotWebchat(requestParameters: DefaultApiGetBotWebchatRequest, options?: AxiosRequestConfig): AxiosPromise<GetBotWebchatResponse>;
3767
3767
  /**
3768
3768
  * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
3769
- * @param {string} id Conversation id
3769
+ * @param {DefaultApiGetConversationRequest} requestParameters Request parameters.
3770
3770
  * @param {*} [options] Override http request option.
3771
3771
  * @throws {RequiredError}
3772
3772
  */
3773
- getConversation(id: string, options?: any): AxiosPromise<GetConversationResponse>;
3773
+ getConversation(requestParameters: DefaultApiGetConversationRequest, options?: AxiosRequestConfig): AxiosPromise<GetConversationResponse>;
3774
3774
  /**
3775
3775
  * Retrieves the [Event](#schema_event) object for a valid identifiers.
3776
- * @param {string} id Event id
3776
+ * @param {DefaultApiGetEventRequest} requestParameters Request parameters.
3777
3777
  * @param {*} [options] Override http request option.
3778
3778
  * @throws {RequiredError}
3779
3779
  */
3780
- getEvent(id: string, options?: any): AxiosPromise<GetEventResponse>;
3780
+ getEvent(requestParameters: DefaultApiGetEventRequest, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
3781
3781
  /**
3782
3782
  * Get File
3783
- * @param {string} id File ID
3783
+ * @param {DefaultApiGetFileRequest} requestParameters Request parameters.
3784
3784
  * @param {*} [options] Override http request option.
3785
3785
  * @throws {RequiredError}
3786
3786
  */
3787
- getFile(id: string, options?: any): AxiosPromise<GetFileResponse>;
3787
+ getFile(requestParameters: DefaultApiGetFileRequest, options?: AxiosRequestConfig): AxiosPromise<GetFileResponse>;
3788
3788
  /**
3789
3789
  * Get integration
3790
- * @param {string} id Integration Id
3790
+ * @param {DefaultApiGetIntegrationRequest} requestParameters Request parameters.
3791
3791
  * @param {*} [options] Override http request option.
3792
3792
  * @throws {RequiredError}
3793
3793
  */
3794
- getIntegration(id: string, options?: any): AxiosPromise<GetIntegrationResponse>;
3794
+ getIntegration(requestParameters: DefaultApiGetIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationResponse>;
3795
3795
  /**
3796
3796
  * Get integration
3797
- * @param {string} name Integration Name
3798
- * @param {string} version Integration version. Either a semver version or tag \&quot;latest\&quot;
3797
+ * @param {DefaultApiGetIntegrationByNameRequest} requestParameters Request parameters.
3799
3798
  * @param {*} [options] Override http request option.
3800
3799
  * @throws {RequiredError}
3801
3800
  */
3802
- getIntegrationByName(name: string, version: string, options?: any): AxiosPromise<GetIntegrationByNameResponse>;
3801
+ getIntegrationByName(requestParameters: DefaultApiGetIntegrationByNameRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationByNameResponse>;
3803
3802
  /**
3804
3803
  * Get integration logs
3805
- * @param {string} id Integration Id
3804
+ * @param {DefaultApiGetIntegrationLogsRequest} requestParameters Request parameters.
3806
3805
  * @param {*} [options] Override http request option.
3807
3806
  * @throws {RequiredError}
3808
3807
  */
3809
- getIntegrationLogs(id: string, options?: any): AxiosPromise<GetIntegrationLogsResponse>;
3808
+ getIntegrationLogs(requestParameters: DefaultApiGetIntegrationLogsRequest, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationLogsResponse>;
3810
3809
  /**
3811
3810
  * Retrieves the [Message](#schema_message) object for a valid identifier.
3812
- * @param {string} id Id of the Message
3811
+ * @param {DefaultApiGetMessageRequest} requestParameters Request parameters.
3813
3812
  * @param {*} [options] Override http request option.
3814
3813
  * @throws {RequiredError}
3815
3814
  */
3816
- getMessage(id: string, options?: any): AxiosPromise<GetMessageResponse>;
3815
+ getMessage(requestParameters: DefaultApiGetMessageRequest, options?: AxiosRequestConfig): AxiosPromise<GetMessageResponse>;
3817
3816
  /**
3818
3817
  * Retrieves the [Conversation](#schema_conversation) object for a valid identifier. If the conversation does not exist, it will be created.
3819
- * @param {GetOrCreateConversationBody} [getOrCreateConversationBody] Conversation data
3818
+ * @param {DefaultApiGetOrCreateConversationRequest} requestParameters Request parameters.
3820
3819
  * @param {*} [options] Override http request option.
3821
3820
  * @throws {RequiredError}
3822
3821
  */
3823
- getOrCreateConversation(getOrCreateConversationBody?: GetOrCreateConversationBody, options?: any): AxiosPromise<GetOrCreateConversationResponse>;
3822
+ getOrCreateConversation(requestParameters?: DefaultApiGetOrCreateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateConversationResponse>;
3824
3823
  /**
3825
3824
  * Retrieves the [Message](#schema_message) object for a valid identifier. If the message does not exist, it will be created.
3826
- * @param {GetOrCreateMessageBody} [getOrCreateMessageBody] Message data
3825
+ * @param {DefaultApiGetOrCreateMessageRequest} requestParameters Request parameters.
3827
3826
  * @param {*} [options] Override http request option.
3828
3827
  * @throws {RequiredError}
3829
3828
  */
3830
- getOrCreateMessage(getOrCreateMessageBody?: GetOrCreateMessageBody, options?: any): AxiosPromise<GetOrCreateMessageResponse>;
3829
+ getOrCreateMessage(requestParameters?: DefaultApiGetOrCreateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateMessageResponse>;
3831
3830
  /**
3832
3831
  * Retrieves the [User](#schema_user) object for a valid identifier. If the user does not exist, it will be created.
3833
- * @param {GetOrCreateUserBody} [getOrCreateUserBody] User data
3832
+ * @param {DefaultApiGetOrCreateUserRequest} requestParameters Request parameters.
3834
3833
  * @param {*} [options] Override http request option.
3835
3834
  * @throws {RequiredError}
3836
3835
  */
3837
- getOrCreateUser(getOrCreateUserBody?: GetOrCreateUserBody, options?: any): AxiosPromise<GetOrCreateUserResponse>;
3836
+ getOrCreateUser(requestParameters?: DefaultApiGetOrCreateUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateUserResponse>;
3838
3837
  /**
3839
3838
  * Get public integration by name and version
3840
- * @param {string} name Integration Name
3841
- * @param {string} version Integration version. Either a semver version or tag \&quot;latest\&quot;
3839
+ * @param {DefaultApiGetPublicIntegrationRequest} requestParameters Request parameters.
3842
3840
  * @param {*} [options] Override http request option.
3843
3841
  * @throws {RequiredError}
3844
3842
  */
3845
- getPublicIntegration(name: string, version: string, options?: any): AxiosPromise<GetPublicIntegrationResponse>;
3843
+ getPublicIntegration(requestParameters: DefaultApiGetPublicIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationResponse>;
3846
3844
  /**
3847
3845
  * Get public integration by Id
3848
- * @param {string} id Integration Id
3846
+ * @param {DefaultApiGetPublicIntegrationByIdRequest} requestParameters Request parameters.
3849
3847
  * @param {*} [options] Override http request option.
3850
3848
  * @throws {RequiredError}
3851
3849
  */
3852
- getPublicIntegrationById(id: string, options?: any): AxiosPromise<GetPublicIntegrationByIdResponse>;
3850
+ getPublicIntegrationById(requestParameters: DefaultApiGetPublicIntegrationByIdRequest, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationByIdResponse>;
3853
3851
  /**
3854
3852
  * Retrieves the [State](#schema_state) object for a valid identifiers.
3855
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
3856
- * @param {string} id State id
3857
- * @param {string} name State name
3853
+ * @param {DefaultApiGetStateRequest} requestParameters Request parameters.
3858
3854
  * @param {*} [options] Override http request option.
3859
3855
  * @throws {RequiredError}
3860
3856
  */
3861
- getState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, options?: any): AxiosPromise<GetStateResponse>;
3857
+ getState(requestParameters: DefaultApiGetStateRequest, options?: AxiosRequestConfig): AxiosPromise<GetStateResponse>;
3862
3858
  /**
3863
3859
  * Retrieves the [User](#schema_user) object for a valid identifier.
3864
- * @param {string} id User ID
3860
+ * @param {DefaultApiGetUserRequest} requestParameters Request parameters.
3865
3861
  * @param {*} [options] Override http request option.
3866
3862
  * @throws {RequiredError}
3867
3863
  */
3868
- getUser(id: string, options?: any): AxiosPromise<GetUserResponse>;
3864
+ getUser(requestParameters: DefaultApiGetUserRequest, options?: AxiosRequestConfig): AxiosPromise<GetUserResponse>;
3869
3865
  /**
3870
3866
  * Get workspace details
3871
- * @param {string} id Workspace ID
3867
+ * @param {DefaultApiGetWorkspaceRequest} requestParameters Request parameters.
3872
3868
  * @param {*} [options] Override http request option.
3873
3869
  * @throws {RequiredError}
3874
3870
  */
3875
- getWorkspace(id: string, options?: any): AxiosPromise<GetWorkspaceResponse>;
3871
+ getWorkspace(requestParameters: DefaultApiGetWorkspaceRequest, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
3876
3872
  /**
3877
3873
  * Introspect the API
3878
- * @param {IntrospectBody} [introspectBody]
3874
+ * @param {DefaultApiIntrospectRequest} requestParameters Request parameters.
3879
3875
  * @param {*} [options] Override http request option.
3880
3876
  * @throws {RequiredError}
3881
3877
  */
3882
- introspect(introspectBody?: IntrospectBody, options?: any): AxiosPromise<IntrospectResponse>;
3878
+ introspect(requestParameters?: DefaultApiIntrospectRequest, options?: AxiosRequestConfig): AxiosPromise<IntrospectResponse>;
3883
3879
  /**
3884
3880
  * List bots
3885
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3881
+ * @param {DefaultApiListBotsRequest} requestParameters Request parameters.
3886
3882
  * @param {*} [options] Override http request option.
3887
3883
  * @throws {RequiredError}
3888
3884
  */
3889
- listBots(nextToken?: string, options?: any): AxiosPromise<ListBotsResponse>;
3885
+ listBots(requestParameters?: DefaultApiListBotsRequest, options?: AxiosRequestConfig): AxiosPromise<ListBotsResponse>;
3890
3886
  /**
3891
3887
  * Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
3892
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3893
- * @param {{ [key: string]: string; }} [tags] Filter by tags
3894
- * @param {Array<string>} [participantIds] Filter by participant ids
3888
+ * @param {DefaultApiListConversationsRequest} requestParameters Request parameters.
3895
3889
  * @param {*} [options] Override http request option.
3896
3890
  * @throws {RequiredError}
3897
3891
  */
3898
- listConversations(nextToken?: string, tags?: {
3899
- [key: string]: string;
3900
- } | undefined, participantIds?: Array<string>, options?: any): AxiosPromise<ListConversationsResponse>;
3892
+ listConversations(requestParameters?: DefaultApiListConversationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
3901
3893
  /**
3902
3894
  * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
3903
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3895
+ * @param {DefaultApiListEventsRequest} requestParameters Request parameters.
3904
3896
  * @param {*} [options] Override http request option.
3905
3897
  * @throws {RequiredError}
3906
3898
  */
3907
- listEvents(nextToken?: string, options?: any): AxiosPromise<ListEventsResponse>;
3899
+ listEvents(requestParameters?: DefaultApiListEventsRequest, options?: AxiosRequestConfig): AxiosPromise<ListEventsResponse>;
3908
3900
  /**
3909
3901
  * List Files
3910
- * @param {string} botId Bot ID
3911
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3902
+ * @param {DefaultApiListFilesRequest} requestParameters Request parameters.
3912
3903
  * @param {*} [options] Override http request option.
3913
3904
  * @throws {RequiredError}
3914
3905
  */
3915
- listFiles(botId: string, nextToken?: string, options?: any): AxiosPromise<ListFilesResponse>;
3906
+ listFiles(requestParameters: DefaultApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
3916
3907
  /**
3917
3908
  * List integrations
3918
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3919
- * @param {string} [name] Integration Name
3920
- * @param {string} [version] Integration version. Either a semver version or tag \&quot;latest\&quot;
3909
+ * @param {DefaultApiListIntegrationsRequest} requestParameters Request parameters.
3921
3910
  * @param {*} [options] Override http request option.
3922
3911
  * @throws {RequiredError}
3923
3912
  */
3924
- listIntegrations(nextToken?: string, name?: string, version?: string, options?: any): AxiosPromise<ListIntegrationsResponse>;
3913
+ listIntegrations(requestParameters?: DefaultApiListIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListIntegrationsResponse>;
3925
3914
  /**
3926
3915
  * Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
3927
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3928
- * @param {string} [conversationId] Conversation id
3929
- * @param {{ [key: string]: string; }} [tags] Filter by tags
3916
+ * @param {DefaultApiListMessagesRequest} requestParameters Request parameters.
3930
3917
  * @param {*} [options] Override http request option.
3931
3918
  * @throws {RequiredError}
3932
3919
  */
3933
- listMessages(nextToken?: string, conversationId?: string, tags?: {
3934
- [key: string]: string;
3935
- } | undefined, options?: any): AxiosPromise<ListMessagesResponse>;
3920
+ listMessages(requestParameters?: DefaultApiListMessagesRequest, options?: AxiosRequestConfig): AxiosPromise<ListMessagesResponse>;
3936
3921
  /**
3937
3922
  * List public integration
3938
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3939
- * @param {string} [name] Integration Name
3940
- * @param {string} [version] Integration version. Either a semver version or tag \&quot;latest\&quot;
3923
+ * @param {DefaultApiListPublicIntegrationsRequest} requestParameters Request parameters.
3941
3924
  * @param {*} [options] Override http request option.
3942
3925
  * @throws {RequiredError}
3943
3926
  */
3944
- listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?: any): AxiosPromise<ListPublicIntegrationsResponse>;
3927
+ listPublicIntegrations(requestParameters?: DefaultApiListPublicIntegrationsRequest, options?: AxiosRequestConfig): AxiosPromise<ListPublicIntegrationsResponse>;
3945
3928
  /**
3946
3929
  * Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
3947
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3948
- * @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
3949
- * @param {{ [key: string]: string; }} [tags] Filter by tags
3930
+ * @param {DefaultApiListUsersRequest} requestParameters Request parameters.
3950
3931
  * @param {*} [options] Override http request option.
3951
3932
  * @throws {RequiredError}
3952
3933
  */
3953
- listUsers(nextToken?: string, conversationId?: string, tags?: {
3954
- [key: string]: string;
3955
- } | undefined, options?: any): AxiosPromise<ListUsersResponse>;
3934
+ listUsers(requestParameters?: DefaultApiListUsersRequest, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
3956
3935
  /**
3957
3936
  * List workspaces the user has access to
3958
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
3937
+ * @param {DefaultApiListWorkspacesRequest} requestParameters Request parameters.
3959
3938
  * @param {*} [options] Override http request option.
3960
3939
  * @throws {RequiredError}
3961
3940
  */
3962
- listWorkspaces(nextToken?: string, options?: any): AxiosPromise<ListWorkspacesResponse>;
3941
+ listWorkspaces(requestParameters?: DefaultApiListWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<ListWorkspacesResponse>;
3963
3942
  /**
3964
3943
  * Updates the [State](#schema_state) object by setting the values of the parameters passed.
3965
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
3966
- * @param {string} id State id
3967
- * @param {string} name State name
3968
- * @param {PatchStateBody} [patchStateBody] State content
3944
+ * @param {DefaultApiPatchStateRequest} requestParameters Request parameters.
3969
3945
  * @param {*} [options] Override http request option.
3970
3946
  * @throws {RequiredError}
3971
3947
  */
3972
- patchState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, patchStateBody?: PatchStateBody, options?: any): AxiosPromise<PatchStateResponse>;
3948
+ patchState(requestParameters: DefaultApiPatchStateRequest, options?: AxiosRequestConfig): AxiosPromise<PatchStateResponse>;
3973
3949
  /**
3974
3950
  * Overrides the [State](#schema_state) object by setting the values of the parameters passed.
3975
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
3976
- * @param {string} id State id
3977
- * @param {string} name State name
3978
- * @param {SetStateBody} [setStateBody] State content
3951
+ * @param {DefaultApiSetStateRequest} requestParameters Request parameters.
3979
3952
  * @param {*} [options] Override http request option.
3980
3953
  * @throws {RequiredError}
3981
3954
  */
3982
- setState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, setStateBody?: SetStateBody, options?: any): AxiosPromise<SetStateResponse>;
3955
+ setState(requestParameters: DefaultApiSetStateRequest, options?: AxiosRequestConfig): AxiosPromise<SetStateResponse>;
3983
3956
  /**
3984
3957
  * Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
3985
- * @param {string} id Bot ID
3986
- * @param {TransferBotBody} [transferBotBody] Bot transfer request
3958
+ * @param {DefaultApiTransferBotRequest} requestParameters Request parameters.
3987
3959
  * @param {*} [options] Override http request option.
3988
3960
  * @throws {RequiredError}
3989
3961
  */
3990
- transferBot(id: string, transferBotBody?: TransferBotBody, options?: any): AxiosPromise<object>;
3962
+ transferBot(requestParameters: DefaultApiTransferBotRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
3991
3963
  /**
3992
3964
  * Update bot
3993
- * @param {string} id Bot ID
3994
- * @param {UpdateBotBody} [updateBotBody] Bot metadata
3965
+ * @param {DefaultApiUpdateBotRequest} requestParameters Request parameters.
3995
3966
  * @param {*} [options] Override http request option.
3996
3967
  * @throws {RequiredError}
3997
3968
  */
3998
- updateBot(id: string, updateBotBody?: UpdateBotBody, options?: any): AxiosPromise<UpdateBotResponse>;
3969
+ updateBot(requestParameters: DefaultApiUpdateBotRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateBotResponse>;
3999
3970
  /**
4000
3971
  * Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
4001
- * @param {string} id Conversation id
4002
- * @param {UpdateConversationBody} [updateConversationBody] Conversation data
3972
+ * @param {DefaultApiUpdateConversationRequest} requestParameters Request parameters.
4003
3973
  * @param {*} [options] Override http request option.
4004
3974
  * @throws {RequiredError}
4005
3975
  */
4006
- updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?: any): AxiosPromise<UpdateConversationResponse>;
3976
+ updateConversation(requestParameters: DefaultApiUpdateConversationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateConversationResponse>;
4007
3977
  /**
4008
3978
  * Update integration
4009
- * @param {string} id Integration Id
4010
- * @param {UpdateIntegrationBody} [updateIntegrationBody] Integration
3979
+ * @param {DefaultApiUpdateIntegrationRequest} requestParameters Request parameters.
4011
3980
  * @param {*} [options] Override http request option.
4012
3981
  * @throws {RequiredError}
4013
3982
  */
4014
- updateIntegration(id: string, updateIntegrationBody?: UpdateIntegrationBody, options?: any): AxiosPromise<UpdateIntegrationResponse>;
3983
+ updateIntegration(requestParameters: DefaultApiUpdateIntegrationRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateIntegrationResponse>;
4015
3984
  /**
4016
3985
  * Update a message
4017
- * @param {string} id Message id
4018
- * @param {UpdateMessageBody} [updateMessageBody] Message data
3986
+ * @param {DefaultApiUpdateMessageRequest} requestParameters Request parameters.
4019
3987
  * @param {*} [options] Override http request option.
4020
3988
  * @throws {RequiredError}
4021
3989
  */
4022
- updateMessage(id: string, updateMessageBody?: UpdateMessageBody, options?: any): AxiosPromise<UpdateMessageResponse>;
3990
+ updateMessage(requestParameters: DefaultApiUpdateMessageRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateMessageResponse>;
4023
3991
  /**
4024
3992
  * Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
4025
- * @param {string} id User ID
4026
- * @param {UpdateUserBody} [updateUserBody] User data
3993
+ * @param {DefaultApiUpdateUserRequest} requestParameters Request parameters.
4027
3994
  * @param {*} [options] Override http request option.
4028
3995
  * @throws {RequiredError}
4029
3996
  */
4030
- updateUser(id: string, updateUserBody?: UpdateUserBody, options?: any): AxiosPromise<UpdateUserResponse>;
3997
+ updateUser(requestParameters: DefaultApiUpdateUserRequest, options?: AxiosRequestConfig): AxiosPromise<UpdateUserResponse>;
4031
3998
  };
4032
- /**
4033
- * DefaultApi - interface
4034
- * @export
4035
- * @interface DefaultApi
4036
- */
4037
- export interface DefaultApiInterface {
4038
- /**
4039
- * Call an action
4040
- * @param {CallActionBody} [callActionBody] Action payload
4041
- * @param {*} [options] Override http request option.
4042
- * @throws {RequiredError}
4043
- * @memberof DefaultApiInterface
4044
- */
4045
- callAction(callActionBody?: CallActionBody, options?: AxiosRequestConfig): AxiosPromise<CallActionResponse>;
4046
- /**
4047
- * An integration can call this endpoint to configure itself
4048
- * @param {ConfigureIntegrationBody} [configureIntegrationBody] Configuration of the integration
4049
- * @param {*} [options] Override http request option.
4050
- * @throws {RequiredError}
4051
- * @memberof DefaultApiInterface
4052
- */
4053
- configureIntegration(configureIntegrationBody?: ConfigureIntegrationBody, options?: AxiosRequestConfig): AxiosPromise<object>;
4054
- /**
4055
- * Create bot
4056
- * @param {CreateBotBody} [createBotBody] Bot metadata
4057
- * @param {*} [options] Override http request option.
4058
- * @throws {RequiredError}
4059
- * @memberof DefaultApiInterface
4060
- */
4061
- createBot(createBotBody?: CreateBotBody, options?: AxiosRequestConfig): AxiosPromise<CreateBotResponse>;
4062
- /**
4063
- * Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details.
4064
- * @param {CreateConversationBody} [createConversationBody] Conversation data
4065
- * @param {*} [options] Override http request option.
4066
- * @throws {RequiredError}
4067
- * @memberof DefaultApiInterface
4068
- */
4069
- createConversation(createConversationBody?: CreateConversationBody, options?: AxiosRequestConfig): AxiosPromise<CreateConversationResponse>;
4070
- /**
4071
- * Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.
4072
- * @param {CreateEventBody} [createEventBody] Event data
4073
- * @param {*} [options] Override http request option.
4074
- * @throws {RequiredError}
4075
- * @memberof DefaultApiInterface
4076
- */
4077
- createEvent(createEventBody?: CreateEventBody, options?: AxiosRequestConfig): AxiosPromise<CreateEventResponse>;
4078
- /**
4079
- * Create File
4080
- * @param {CreateFileBody} [createFileBody] Create File
4081
- * @param {*} [options] Override http request option.
4082
- * @throws {RequiredError}
4083
- * @memberof DefaultApiInterface
4084
- */
4085
- createFile(createFileBody?: CreateFileBody, options?: AxiosRequestConfig): AxiosPromise<CreateFileResponse>;
4086
- /**
4087
- * Create integration
4088
- * @param {CreateIntegrationBody} [createIntegrationBody] Integration
4089
- * @param {*} [options] Override http request option.
4090
- * @throws {RequiredError}
4091
- * @memberof DefaultApiInterface
4092
- */
4093
- createIntegration(createIntegrationBody?: CreateIntegrationBody, options?: AxiosRequestConfig): AxiosPromise<CreateIntegrationResponse>;
4094
- /**
4095
- * Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details.
4096
- * @param {CreateMessageBody} [createMessageBody] Message data
4097
- * @param {*} [options] Override http request option.
4098
- * @throws {RequiredError}
4099
- * @memberof DefaultApiInterface
4100
- */
4101
- createMessage(createMessageBody?: CreateMessageBody, options?: AxiosRequestConfig): AxiosPromise<CreateMessageResponse>;
4102
- /**
4103
- * 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.
4104
- * @param {CreateUserBody} [createUserBody] User data
4105
- * @param {*} [options] Override http request option.
4106
- * @throws {RequiredError}
4107
- * @memberof DefaultApiInterface
4108
- */
4109
- createUser(createUserBody?: CreateUserBody, options?: AxiosRequestConfig): AxiosPromise<CreateUserResponse>;
4110
- /**
4111
- * Delete bot
4112
- * @param {string} id Bot ID
4113
- * @param {*} [options] Override http request option.
4114
- * @throws {RequiredError}
4115
- * @memberof DefaultApiInterface
4116
- */
4117
- deleteBot(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
4118
- /**
4119
- * Permanently deletes a [Conversation](#schema_conversation). It cannot be undone. Also immediately deletes corresponding [Messages](#schema_message).
4120
- * @param {string} id Conversation id
4121
- * @param {*} [options] Override http request option.
4122
- * @throws {RequiredError}
4123
- * @memberof DefaultApiInterface
4124
- */
4125
- deleteConversation(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
4126
- /**
4127
- * Delete File
4128
- * @param {string} id File ID
4129
- * @param {*} [options] Override http request option.
4130
- * @throws {RequiredError}
4131
- * @memberof DefaultApiInterface
4132
- */
4133
- deleteFile(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
4134
- /**
4135
- * Delete integration
4136
- * @param {string} id Integration Id
4137
- * @param {*} [options] Override http request option.
4138
- * @throws {RequiredError}
4139
- * @memberof DefaultApiInterface
4140
- */
4141
- deleteIntegration(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
4142
- /**
4143
- * Permanently deletes a [Message](#schema_message). It cannot be undone.
4144
- * @param {string} id Message id
4145
- * @param {*} [options] Override http request option.
4146
- * @throws {RequiredError}
4147
- * @memberof DefaultApiInterface
4148
- */
4149
- deleteMessage(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
4150
- /**
4151
- * Permanently deletes a [User](#schema_user). It cannot be undone.
4152
- * @param {string} id User ID
4153
- * @param {*} [options] Override http request option.
4154
- * @throws {RequiredError}
4155
- * @memberof DefaultApiInterface
4156
- */
4157
- deleteUser(id: string, options?: AxiosRequestConfig): AxiosPromise<object>;
4158
- /**
4159
- * Download File
4160
- * @param {string} id File ID
4161
- * @param {*} [options] Override http request option.
4162
- * @throws {RequiredError}
4163
- * @memberof DefaultApiInterface
4164
- */
4165
- downloadFile(id: string, options?: AxiosRequestConfig): AxiosPromise<any>;
4166
- /**
4167
- * Get bot details
4168
- * @param {string} id Bot ID
4169
- * @param {*} [options] Override http request option.
4170
- * @throws {RequiredError}
4171
- * @memberof DefaultApiInterface
4172
- */
4173
- getBot(id: string, options?: AxiosRequestConfig): AxiosPromise<GetBotResponse>;
4174
- /**
4175
- * Get bot analytics
4176
- * @param {string} id Bot ID
4177
- * @param {string} startDate Start date/time (inclusive)
4178
- * @param {string} endDate End date/time (exclusive)
4179
- * @param {*} [options] Override http request option.
4180
- * @throws {RequiredError}
4181
- * @memberof DefaultApiInterface
4182
- */
4183
- getBotAnalytics(id: string, startDate: string, endDate: string, options?: AxiosRequestConfig): AxiosPromise<GetBotAnalyticsResponse>;
4184
- /**
4185
- * Get bot logs
4186
- * @param {string} id Bot ID
4187
- * @param {*} [options] Override http request option.
4188
- * @throws {RequiredError}
4189
- * @memberof DefaultApiInterface
4190
- */
4191
- getBotLogs(id: string, options?: AxiosRequestConfig): AxiosPromise<GetBotLogsResponse>;
4192
- /**
4193
- * Get the webchat code/URL for a bot
4194
- * @param {string} id Bot ID
4195
- * @param {'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl'} type type of script to get
4196
- * @param {*} [options] Override http request option.
4197
- * @throws {RequiredError}
4198
- * @memberof DefaultApiInterface
4199
- */
4200
- getBotWebchat(id: string, type: 'preconfigured' | 'configurable' | 'fullscreen' | 'sharableUrl', options?: AxiosRequestConfig): AxiosPromise<GetBotWebchatResponse>;
4201
- /**
4202
- * Retrieves the [Conversation](#schema_conversation) object for a valid identifier.
4203
- * @param {string} id Conversation id
4204
- * @param {*} [options] Override http request option.
4205
- * @throws {RequiredError}
4206
- * @memberof DefaultApiInterface
4207
- */
4208
- getConversation(id: string, options?: AxiosRequestConfig): AxiosPromise<GetConversationResponse>;
4209
- /**
4210
- * Retrieves the [Event](#schema_event) object for a valid identifiers.
4211
- * @param {string} id Event id
4212
- * @param {*} [options] Override http request option.
4213
- * @throws {RequiredError}
4214
- * @memberof DefaultApiInterface
4215
- */
4216
- getEvent(id: string, options?: AxiosRequestConfig): AxiosPromise<GetEventResponse>;
4217
- /**
4218
- * Get File
4219
- * @param {string} id File ID
4220
- * @param {*} [options] Override http request option.
4221
- * @throws {RequiredError}
4222
- * @memberof DefaultApiInterface
4223
- */
4224
- getFile(id: string, options?: AxiosRequestConfig): AxiosPromise<GetFileResponse>;
4225
- /**
4226
- * Get integration
4227
- * @param {string} id Integration Id
4228
- * @param {*} [options] Override http request option.
4229
- * @throws {RequiredError}
4230
- * @memberof DefaultApiInterface
4231
- */
4232
- getIntegration(id: string, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationResponse>;
4233
- /**
4234
- * Get integration
4235
- * @param {string} name Integration Name
4236
- * @param {string} version Integration version. Either a semver version or tag \&quot;latest\&quot;
4237
- * @param {*} [options] Override http request option.
4238
- * @throws {RequiredError}
4239
- * @memberof DefaultApiInterface
4240
- */
4241
- getIntegrationByName(name: string, version: string, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationByNameResponse>;
4242
- /**
4243
- * Get integration logs
4244
- * @param {string} id Integration Id
4245
- * @param {*} [options] Override http request option.
4246
- * @throws {RequiredError}
4247
- * @memberof DefaultApiInterface
4248
- */
4249
- getIntegrationLogs(id: string, options?: AxiosRequestConfig): AxiosPromise<GetIntegrationLogsResponse>;
4250
- /**
4251
- * Retrieves the [Message](#schema_message) object for a valid identifier.
4252
- * @param {string} id Id of the Message
4253
- * @param {*} [options] Override http request option.
4254
- * @throws {RequiredError}
4255
- * @memberof DefaultApiInterface
4256
- */
4257
- getMessage(id: string, options?: AxiosRequestConfig): AxiosPromise<GetMessageResponse>;
4258
- /**
4259
- * Retrieves the [Conversation](#schema_conversation) object for a valid identifier. If the conversation does not exist, it will be created.
4260
- * @param {GetOrCreateConversationBody} [getOrCreateConversationBody] Conversation data
4261
- * @param {*} [options] Override http request option.
4262
- * @throws {RequiredError}
4263
- * @memberof DefaultApiInterface
4264
- */
4265
- getOrCreateConversation(getOrCreateConversationBody?: GetOrCreateConversationBody, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateConversationResponse>;
4266
- /**
4267
- * Retrieves the [Message](#schema_message) object for a valid identifier. If the message does not exist, it will be created.
4268
- * @param {GetOrCreateMessageBody} [getOrCreateMessageBody] Message data
4269
- * @param {*} [options] Override http request option.
4270
- * @throws {RequiredError}
4271
- * @memberof DefaultApiInterface
4272
- */
4273
- getOrCreateMessage(getOrCreateMessageBody?: GetOrCreateMessageBody, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateMessageResponse>;
4274
- /**
4275
- * Retrieves the [User](#schema_user) object for a valid identifier. If the user does not exist, it will be created.
4276
- * @param {GetOrCreateUserBody} [getOrCreateUserBody] User data
4277
- * @param {*} [options] Override http request option.
4278
- * @throws {RequiredError}
4279
- * @memberof DefaultApiInterface
4280
- */
4281
- getOrCreateUser(getOrCreateUserBody?: GetOrCreateUserBody, options?: AxiosRequestConfig): AxiosPromise<GetOrCreateUserResponse>;
4282
- /**
4283
- * Get public integration by name and version
4284
- * @param {string} name Integration Name
4285
- * @param {string} version Integration version. Either a semver version or tag \&quot;latest\&quot;
4286
- * @param {*} [options] Override http request option.
4287
- * @throws {RequiredError}
4288
- * @memberof DefaultApiInterface
4289
- */
4290
- getPublicIntegration(name: string, version: string, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationResponse>;
4291
- /**
4292
- * Get public integration by Id
4293
- * @param {string} id Integration Id
4294
- * @param {*} [options] Override http request option.
4295
- * @throws {RequiredError}
4296
- * @memberof DefaultApiInterface
4297
- */
4298
- getPublicIntegrationById(id: string, options?: AxiosRequestConfig): AxiosPromise<GetPublicIntegrationByIdResponse>;
4299
- /**
4300
- * Retrieves the [State](#schema_state) object for a valid identifiers.
4301
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
4302
- * @param {string} id State id
4303
- * @param {string} name State name
4304
- * @param {*} [options] Override http request option.
4305
- * @throws {RequiredError}
4306
- * @memberof DefaultApiInterface
4307
- */
4308
- getState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, options?: AxiosRequestConfig): AxiosPromise<GetStateResponse>;
4309
- /**
4310
- * Retrieves the [User](#schema_user) object for a valid identifier.
4311
- * @param {string} id User ID
4312
- * @param {*} [options] Override http request option.
4313
- * @throws {RequiredError}
4314
- * @memberof DefaultApiInterface
4315
- */
4316
- getUser(id: string, options?: AxiosRequestConfig): AxiosPromise<GetUserResponse>;
4317
- /**
4318
- * Get workspace details
4319
- * @param {string} id Workspace ID
4320
- * @param {*} [options] Override http request option.
4321
- * @throws {RequiredError}
4322
- * @memberof DefaultApiInterface
4323
- */
4324
- getWorkspace(id: string, options?: AxiosRequestConfig): AxiosPromise<GetWorkspaceResponse>;
4325
- /**
4326
- * Introspect the API
4327
- * @param {IntrospectBody} [introspectBody]
4328
- * @param {*} [options] Override http request option.
4329
- * @throws {RequiredError}
4330
- * @memberof DefaultApiInterface
4331
- */
4332
- introspect(introspectBody?: IntrospectBody, options?: AxiosRequestConfig): AxiosPromise<IntrospectResponse>;
4333
- /**
4334
- * List bots
4335
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4336
- * @param {*} [options] Override http request option.
4337
- * @throws {RequiredError}
4338
- * @memberof DefaultApiInterface
4339
- */
4340
- listBots(nextToken?: string, options?: AxiosRequestConfig): AxiosPromise<ListBotsResponse>;
4341
- /**
4342
- * Retrieves a list of [Conversation](#schema_conversation) you’ve previously created. The conversations are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
4343
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4344
- * @param {{ [key: string]: string; }} [tags] Filter by tags
4345
- * @param {Array<string>} [participantIds] Filter by participant ids
4346
- * @param {*} [options] Override http request option.
4347
- * @throws {RequiredError}
4348
- * @memberof DefaultApiInterface
4349
- */
4350
- listConversations(nextToken?: string, tags?: {
4351
- [key: string]: string;
4352
- }, participantIds?: Array<string>, options?: AxiosRequestConfig): AxiosPromise<ListConversationsResponse>;
4353
- /**
4354
- * Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.
4355
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4356
- * @param {*} [options] Override http request option.
4357
- * @throws {RequiredError}
4358
- * @memberof DefaultApiInterface
4359
- */
4360
- listEvents(nextToken?: string, options?: AxiosRequestConfig): AxiosPromise<ListEventsResponse>;
4361
- /**
4362
- * List Files
4363
- * @param {string} botId Bot ID
4364
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4365
- * @param {*} [options] Override http request option.
4366
- * @throws {RequiredError}
4367
- * @memberof DefaultApiInterface
4368
- */
4369
- listFiles(botId: string, nextToken?: string, options?: AxiosRequestConfig): AxiosPromise<ListFilesResponse>;
4370
- /**
4371
- * List integrations
4372
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4373
- * @param {string} [name] Integration Name
4374
- * @param {string} [version] Integration version. Either a semver version or tag \&quot;latest\&quot;
4375
- * @param {*} [options] Override http request option.
4376
- * @throws {RequiredError}
4377
- * @memberof DefaultApiInterface
4378
- */
4379
- listIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig): AxiosPromise<ListIntegrationsResponse>;
4380
- /**
4381
- * Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
4382
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4383
- * @param {string} [conversationId] Conversation id
4384
- * @param {{ [key: string]: string; }} [tags] Filter by tags
4385
- * @param {*} [options] Override http request option.
4386
- * @throws {RequiredError}
4387
- * @memberof DefaultApiInterface
4388
- */
4389
- listMessages(nextToken?: string, conversationId?: string, tags?: {
4390
- [key: string]: string;
4391
- }, options?: AxiosRequestConfig): AxiosPromise<ListMessagesResponse>;
4392
- /**
4393
- * List public integration
4394
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4395
- * @param {string} [name] Integration Name
4396
- * @param {string} [version] Integration version. Either a semver version or tag \&quot;latest\&quot;
4397
- * @param {*} [options] Override http request option.
4398
- * @throws {RequiredError}
4399
- * @memberof DefaultApiInterface
4400
- */
4401
- listPublicIntegrations(nextToken?: string, name?: string, version?: string, options?: AxiosRequestConfig): AxiosPromise<ListPublicIntegrationsResponse>;
4402
- /**
4403
- * Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).
4404
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4405
- * @param {string} [conversationId] Filter by conversation id. This will return all users that have participated in the conversation.
4406
- * @param {{ [key: string]: string; }} [tags] Filter by tags
4407
- * @param {*} [options] Override http request option.
4408
- * @throws {RequiredError}
4409
- * @memberof DefaultApiInterface
4410
- */
4411
- listUsers(nextToken?: string, conversationId?: string, tags?: {
4412
- [key: string]: string;
4413
- }, options?: AxiosRequestConfig): AxiosPromise<ListUsersResponse>;
4414
- /**
4415
- * List workspaces the user has access to
4416
- * @param {string} [nextToken] Provide the &#x60;meta.nextToken&#x60; value provided in the last API response to retrieve the next page of results
4417
- * @param {*} [options] Override http request option.
4418
- * @throws {RequiredError}
4419
- * @memberof DefaultApiInterface
4420
- */
4421
- listWorkspaces(nextToken?: string, options?: AxiosRequestConfig): AxiosPromise<ListWorkspacesResponse>;
4422
- /**
4423
- * Updates the [State](#schema_state) object by setting the values of the parameters passed.
4424
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
4425
- * @param {string} id State id
4426
- * @param {string} name State name
4427
- * @param {PatchStateBody} [patchStateBody] State content
4428
- * @param {*} [options] Override http request option.
4429
- * @throws {RequiredError}
4430
- * @memberof DefaultApiInterface
4431
- */
4432
- patchState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, patchStateBody?: PatchStateBody, options?: AxiosRequestConfig): AxiosPromise<PatchStateResponse>;
4433
- /**
4434
- * Overrides the [State](#schema_state) object by setting the values of the parameters passed.
4435
- * @param {'conversation' | 'user' | 'bot' | 'integration'} type State type
4436
- * @param {string} id State id
4437
- * @param {string} name State name
4438
- * @param {SetStateBody} [setStateBody] State content
4439
- * @param {*} [options] Override http request option.
4440
- * @throws {RequiredError}
4441
- * @memberof DefaultApiInterface
4442
- */
4443
- setState(type: 'conversation' | 'user' | 'bot' | 'integration', id: string, name: string, setStateBody?: SetStateBody, options?: AxiosRequestConfig): AxiosPromise<SetStateResponse>;
4444
- /**
4445
- * Transfer bot to another workspace. You need to be a Manager member of the workspace the bot currently belongs to and have permission to create bots in the target workspace.
4446
- * @param {string} id Bot ID
4447
- * @param {TransferBotBody} [transferBotBody] Bot transfer request
4448
- * @param {*} [options] Override http request option.
4449
- * @throws {RequiredError}
4450
- * @memberof DefaultApiInterface
4451
- */
4452
- transferBot(id: string, transferBotBody?: TransferBotBody, options?: AxiosRequestConfig): AxiosPromise<object>;
4453
- /**
4454
- * Update bot
4455
- * @param {string} id Bot ID
4456
- * @param {UpdateBotBody} [updateBotBody] Bot metadata
4457
- * @param {*} [options] Override http request option.
4458
- * @throws {RequiredError}
4459
- * @memberof DefaultApiInterface
4460
- */
4461
- updateBot(id: string, updateBotBody?: UpdateBotBody, options?: AxiosRequestConfig): AxiosPromise<UpdateBotResponse>;
4462
- /**
4463
- * Update a [Conversation](#schema_conversation) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
4464
- * @param {string} id Conversation id
4465
- * @param {UpdateConversationBody} [updateConversationBody] Conversation data
4466
- * @param {*} [options] Override http request option.
4467
- * @throws {RequiredError}
4468
- * @memberof DefaultApiInterface
4469
- */
4470
- updateConversation(id: string, updateConversationBody?: UpdateConversationBody, options?: AxiosRequestConfig): AxiosPromise<UpdateConversationResponse>;
4471
- /**
4472
- * Update integration
4473
- * @param {string} id Integration Id
4474
- * @param {UpdateIntegrationBody} [updateIntegrationBody] Integration
4475
- * @param {*} [options] Override http request option.
4476
- * @throws {RequiredError}
4477
- * @memberof DefaultApiInterface
4478
- */
4479
- updateIntegration(id: string, updateIntegrationBody?: UpdateIntegrationBody, options?: AxiosRequestConfig): AxiosPromise<UpdateIntegrationResponse>;
4480
- /**
4481
- * Update a message
4482
- * @param {string} id Message id
4483
- * @param {UpdateMessageBody} [updateMessageBody] Message data
4484
- * @param {*} [options] Override http request option.
4485
- * @throws {RequiredError}
4486
- * @memberof DefaultApiInterface
4487
- */
4488
- updateMessage(id: string, updateMessageBody?: UpdateMessageBody, options?: AxiosRequestConfig): AxiosPromise<UpdateMessageResponse>;
4489
- /**
4490
- * Update a [User](#schema_user) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
4491
- * @param {string} id User ID
4492
- * @param {UpdateUserBody} [updateUserBody] User data
4493
- * @param {*} [options] Override http request option.
4494
- * @throws {RequiredError}
4495
- * @memberof DefaultApiInterface
4496
- */
4497
- updateUser(id: string, updateUserBody?: UpdateUserBody, options?: AxiosRequestConfig): AxiosPromise<UpdateUserResponse>;
4498
- }
4499
3999
  /**
4500
4000
  * Request parameters for callAction operation in DefaultApi.
4501
4001
  * @export
@@ -5058,6 +4558,12 @@ export interface DefaultApiListEventsRequest {
5058
4558
  * @memberof DefaultApiListEvents
5059
4559
  */
5060
4560
  readonly nextToken?: string;
4561
+ /**
4562
+ * Filter by event type
4563
+ * @type {string}
4564
+ * @memberof DefaultApiListEvents
4565
+ */
4566
+ readonly type?: string;
5061
4567
  }
5062
4568
  /**
5063
4569
  * Request parameters for listFiles operation in DefaultApi.
@@ -5377,7 +4883,7 @@ export interface DefaultApiUpdateUserRequest {
5377
4883
  * @class DefaultApi
5378
4884
  * @extends {BaseAPI}
5379
4885
  */
5380
- export declare class DefaultApi extends BaseAPI implements DefaultApiInterface {
4886
+ export declare class DefaultApi extends BaseAPI {
5381
4887
  /**
5382
4888
  * Call an action
5383
4889
  * @param {DefaultApiCallActionRequest} requestParameters Request parameters.