@emilgroup/accounting-sdk-node 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +52 -15
- package/README.md +2 -2
- package/api/health-api.ts +7 -7
- package/api/mailbox-api.ts +255 -0
- package/api/messages-api.ts +1100 -0
- package/api/users-api.ts +496 -0
- package/api/vbas-api.ts +592 -0
- package/api/vbus-api.ts +701 -0
- package/api/zip-codes-api.ts +443 -0
- package/api.ts +14 -6
- package/base.ts +2 -2
- package/common.ts +4 -4
- package/configuration.ts +2 -2
- package/dist/api/health-api.d.ts +6 -6
- package/dist/api/health-api.js +7 -7
- package/dist/api/mailbox-api.d.ts +142 -0
- package/dist/api/mailbox-api.js +315 -0
- package/dist/api/messages-api.d.ts +632 -0
- package/dist/api/messages-api.js +916 -0
- package/dist/api/users-api.d.ts +275 -0
- package/dist/api/users-api.js +512 -0
- package/dist/api/vbas-api.d.ts +337 -0
- package/dist/api/{financial-accounts-api.js → vbas-api.js} +161 -156
- package/dist/api/vbus-api.d.ts +395 -0
- package/dist/api/vbus-api.js +647 -0
- package/dist/api/zip-codes-api.d.ts +253 -0
- package/dist/api/{booking-processes-api.js → zip-codes-api.js} +166 -80
- package/dist/api.d.ts +8 -4
- package/dist/api.js +8 -4
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +4 -4
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/models/address-class.d.ts +48 -0
- package/dist/models/{get-financial-account-response-class.js → address-class.js} +2 -2
- package/dist/models/create-mailbox-request-dto.d.ts +36 -0
- package/dist/models/{create-booking-process-response-class.js → create-mailbox-request-dto.js} +2 -2
- package/dist/models/create-user-request-dto.d.ts +76 -0
- package/dist/models/{financial-account-class.js → create-user-request-dto.js} +10 -9
- package/dist/models/create-user-response-class.d.ts +25 -0
- package/dist/models/{financial-transaction-class.js → create-user-response-class.js} +2 -2
- package/dist/models/create-vba-request-dto.d.ts +41 -0
- package/dist/models/create-vba-request-dto.js +20 -0
- package/dist/models/create-vba-response-class.d.ts +24 -0
- package/dist/models/{create-financial-account-response-class.js → create-vba-response-class.js} +2 -2
- package/dist/models/create-vbu-request-dto.d.ts +41 -0
- package/dist/models/create-vbu-request-dto.js +20 -0
- package/dist/models/create-vbu-response-class.d.ts +24 -0
- package/dist/models/create-vbu-response-class.js +15 -0
- package/dist/models/create-vbuv-request-dto.d.ts +41 -0
- package/dist/models/create-vbuv-request-dto.js +20 -0
- package/dist/models/create-vbuv-response-class.d.ts +24 -0
- package/dist/models/create-vbuv-response-class.js +15 -0
- package/dist/models/get-request-message-response-class.d.ts +25 -0
- package/dist/models/get-request-message-response-class.js +15 -0
- package/dist/models/get-response-message-response-class.d.ts +25 -0
- package/dist/models/get-response-message-response-class.js +15 -0
- package/dist/models/get-user-response-class.d.ts +25 -0
- package/dist/models/get-user-response-class.js +15 -0
- package/dist/models/get-vba-response-class.d.ts +25 -0
- package/dist/models/get-vba-response-class.js +15 -0
- package/dist/models/get-vbu-response-class.d.ts +25 -0
- package/dist/models/get-vbu-response-class.js +15 -0
- package/dist/models/get-zip-code-response-class.d.ts +25 -0
- package/dist/models/get-zip-code-response-class.js +15 -0
- package/dist/models/index.d.ts +46 -13
- package/dist/models/index.js +46 -13
- package/dist/models/inline-response200.d.ts +2 -2
- package/dist/models/inline-response200.js +2 -2
- package/dist/models/inline-response503.d.ts +2 -2
- package/dist/models/inline-response503.js +2 -2
- package/dist/models/list-all-messages-response-class.d.ts +31 -0
- package/dist/models/list-all-messages-response-class.js +15 -0
- package/dist/models/list-requests-messages-response-class.d.ts +31 -0
- package/dist/models/list-requests-messages-response-class.js +15 -0
- package/dist/models/list-responses-messages-response-class.d.ts +31 -0
- package/dist/models/list-responses-messages-response-class.js +15 -0
- package/dist/models/list-users-response-class.d.ts +31 -0
- package/dist/models/list-users-response-class.js +15 -0
- package/dist/models/list-vbas-response-class.d.ts +31 -0
- package/dist/models/list-vbas-response-class.js +15 -0
- package/dist/models/list-vbus-response-class.d.ts +31 -0
- package/dist/models/list-vbus-response-class.js +15 -0
- package/dist/models/list-zip-codes-response-class.d.ts +31 -0
- package/dist/models/list-zip-codes-response-class.js +15 -0
- package/dist/models/message-class.d.ts +84 -0
- package/dist/models/message-class.js +15 -0
- package/dist/models/request-details-class.d.ts +48 -0
- package/dist/models/request-details-class.js +15 -0
- package/dist/models/request-message-class.d.ts +121 -0
- package/dist/models/request-message-class.js +15 -0
- package/dist/models/response-details-class.d.ts +42 -0
- package/dist/models/response-details-class.js +15 -0
- package/dist/models/response-message-class.d.ts +133 -0
- package/dist/models/response-message-class.js +15 -0
- package/dist/models/store-zip-codes-request-dto.d.ts +25 -0
- package/dist/models/store-zip-codes-request-dto.js +15 -0
- package/dist/models/store-zip-codes-response-class.d.ts +25 -0
- package/dist/models/store-zip-codes-response-class.js +15 -0
- package/dist/models/update-request-message-request-dto.d.ts +36 -0
- package/dist/models/update-request-message-request-dto.js +15 -0
- package/dist/models/update-request-message-response-class.d.ts +25 -0
- package/dist/models/update-request-message-response-class.js +15 -0
- package/dist/models/update-response-message-request-dto.d.ts +36 -0
- package/dist/models/update-response-message-request-dto.js +15 -0
- package/dist/models/update-response-message-response-class.d.ts +25 -0
- package/dist/models/update-response-message-response-class.js +15 -0
- package/dist/models/update-user-request-dto.d.ts +82 -0
- package/dist/models/{financial-transaction-data-dto.js → update-user-request-dto.js} +10 -6
- package/dist/models/update-user-response-class.d.ts +25 -0
- package/dist/models/update-user-response-class.js +15 -0
- package/dist/models/update-vba-request-dto.d.ts +30 -0
- package/dist/models/update-vba-request-dto.js +15 -0
- package/dist/models/update-vbu-request-dto.d.ts +30 -0
- package/dist/models/update-vbu-request-dto.js +15 -0
- package/dist/models/update-vbu-response-class.d.ts +25 -0
- package/dist/models/update-vbu-response-class.js +15 -0
- package/dist/models/user-class.d.ts +107 -0
- package/dist/models/user-class.js +20 -0
- package/dist/models/vba-class.d.ts +116 -0
- package/dist/models/vba-class.js +15 -0
- package/dist/models/vba-response-class.d.ts +48 -0
- package/dist/models/vba-response-class.js +15 -0
- package/dist/models/vbu-class.d.ts +115 -0
- package/dist/models/vbu-class.js +15 -0
- package/dist/models/vbu-response-class.d.ts +48 -0
- package/dist/models/vbu-response-class.js +15 -0
- package/dist/models/xlsx-zip-code-dto.d.ts +30 -0
- package/dist/models/xlsx-zip-code-dto.js +15 -0
- package/dist/models/zip-code-class.d.ts +60 -0
- package/dist/models/zip-code-class.js +15 -0
- package/index.ts +2 -2
- package/models/address-class.ts +54 -0
- package/models/create-mailbox-request-dto.ts +42 -0
- package/models/create-user-request-dto.ts +86 -0
- package/models/create-user-response-class.ts +31 -0
- package/models/create-vba-request-dto.ts +50 -0
- package/models/create-vba-response-class.ts +30 -0
- package/models/create-vbu-request-dto.ts +50 -0
- package/models/create-vbu-response-class.ts +30 -0
- package/models/create-vbuv-request-dto.ts +50 -0
- package/models/create-vbuv-response-class.ts +30 -0
- package/models/get-request-message-response-class.ts +31 -0
- package/models/get-response-message-response-class.ts +31 -0
- package/models/get-user-response-class.ts +31 -0
- package/models/get-vba-response-class.ts +31 -0
- package/models/get-vbu-response-class.ts +31 -0
- package/models/get-zip-code-response-class.ts +31 -0
- package/models/index.ts +46 -13
- package/models/inline-response200.ts +2 -2
- package/models/inline-response503.ts +2 -2
- package/models/list-all-messages-response-class.ts +37 -0
- package/models/list-requests-messages-response-class.ts +37 -0
- package/models/list-responses-messages-response-class.ts +37 -0
- package/models/list-users-response-class.ts +37 -0
- package/models/list-vbas-response-class.ts +37 -0
- package/models/list-vbus-response-class.ts +37 -0
- package/models/list-zip-codes-response-class.ts +37 -0
- package/models/message-class.ts +90 -0
- package/models/request-details-class.ts +54 -0
- package/models/request-message-class.ts +127 -0
- package/models/response-details-class.ts +48 -0
- package/models/response-message-class.ts +139 -0
- package/models/store-zip-codes-request-dto.ts +31 -0
- package/models/store-zip-codes-response-class.ts +31 -0
- package/models/update-request-message-request-dto.ts +42 -0
- package/models/update-request-message-response-class.ts +31 -0
- package/models/update-response-message-request-dto.ts +42 -0
- package/models/update-response-message-response-class.ts +31 -0
- package/models/update-user-request-dto.ts +92 -0
- package/models/update-user-response-class.ts +31 -0
- package/models/update-vba-request-dto.ts +36 -0
- package/models/update-vbu-request-dto.ts +36 -0
- package/models/update-vbu-response-class.ts +31 -0
- package/models/user-class.ts +116 -0
- package/models/vba-class.ts +122 -0
- package/models/vba-response-class.ts +54 -0
- package/models/vbu-class.ts +121 -0
- package/models/vbu-response-class.ts +54 -0
- package/models/xlsx-zip-code-dto.ts +36 -0
- package/models/zip-code-class.ts +66 -0
- package/package.json +1 -1
- package/api/booking-processes-api.ts +0 -357
- package/api/financial-accounts-api.ts +0 -577
- package/dist/api/booking-processes-api.d.ts +0 -207
- package/dist/api/financial-accounts-api.d.ts +0 -327
- package/dist/models/booking-entry-class.d.ts +0 -123
- package/dist/models/booking-entry-class.js +0 -34
- package/dist/models/booking-process-class.d.ts +0 -94
- package/dist/models/booking-process-class.js +0 -29
- package/dist/models/create-booking-entry-request-dto.d.ts +0 -99
- package/dist/models/create-booking-entry-request-dto.js +0 -34
- package/dist/models/create-booking-process-request-dto.d.ts +0 -64
- package/dist/models/create-booking-process-request-dto.js +0 -29
- package/dist/models/create-booking-process-response-class.d.ts +0 -25
- package/dist/models/create-financial-account-request-dto.d.ts +0 -62
- package/dist/models/create-financial-account-request-dto.js +0 -23
- package/dist/models/create-financial-account-response-class.d.ts +0 -25
- package/dist/models/financial-account-class.d.ts +0 -98
- package/dist/models/financial-transaction-class.d.ts +0 -108
- package/dist/models/financial-transaction-data-dto.d.ts +0 -71
- package/dist/models/get-financial-account-response-class.d.ts +0 -25
- package/dist/models/list-booking-process-response-class.d.ts +0 -31
- package/dist/models/list-booking-process-response-class.js +0 -15
- package/dist/models/list-financial-accounts-response-class.d.ts +0 -31
- package/dist/models/list-financial-accounts-response-class.js +0 -15
- package/models/booking-entry-class.ts +0 -133
- package/models/booking-process-class.ts +0 -104
- package/models/create-booking-entry-request-dto.ts +0 -109
- package/models/create-booking-process-request-dto.ts +0 -74
- package/models/create-booking-process-response-class.ts +0 -31
- package/models/create-financial-account-request-dto.ts +0 -71
- package/models/create-financial-account-response-class.ts +0 -31
- package/models/financial-account-class.ts +0 -107
- package/models/financial-transaction-class.ts +0 -114
- package/models/financial-transaction-data-dto.ts +0 -80
- package/models/get-financial-account-response-class.ts +0 -31
- package/models/list-booking-process-response-class.ts +0 -37
- package/models/list-financial-accounts-response-class.ts +0 -37
|
@@ -0,0 +1,632 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL GdvService
|
|
3
|
+
* The EMIL GdvService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { GetRequestMessageResponseClass } from '../models';
|
|
16
|
+
import { GetResponseMessageResponseClass } from '../models';
|
|
17
|
+
import { ListAllMessagesResponseClass } from '../models';
|
|
18
|
+
import { ListRequestsMessagesResponseClass } from '../models';
|
|
19
|
+
import { ListResponsesMessagesResponseClass } from '../models';
|
|
20
|
+
import { UpdateRequestMessageRequestDto } from '../models';
|
|
21
|
+
import { UpdateRequestMessageResponseClass } from '../models';
|
|
22
|
+
import { UpdateResponseMessageRequestDto } from '../models';
|
|
23
|
+
import { UpdateResponseMessageResponseClass } from '../models';
|
|
24
|
+
/**
|
|
25
|
+
* MessagesApi - axios parameter creator
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
export declare const MessagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29
|
+
/**
|
|
30
|
+
* Retrieves the details of the request message that was previously created. Supply the unique request message code that was returned when you created it and Emil Api will return the corresponding request message information.
|
|
31
|
+
* @summary Retrieve the request message
|
|
32
|
+
* @param {string} code Unique identifier for the object.
|
|
33
|
+
* @param {string} [authorization] Bearer Token
|
|
34
|
+
* @param {string} [expand]
|
|
35
|
+
* @param {*} [options] Override http request option.
|
|
36
|
+
* @throws {RequiredError}
|
|
37
|
+
*/
|
|
38
|
+
getRequestMessage: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39
|
+
/**
|
|
40
|
+
* Retrieves the details of the response message that was previously created. Supply the unique response message code that was returned when you created it and Emil Api will return the corresponding response message information.
|
|
41
|
+
* @summary Retrieve the response message
|
|
42
|
+
* @param {string} code Unique identifier for the object.
|
|
43
|
+
* @param {string} [authorization] Bearer Token
|
|
44
|
+
* @param {string} [expand]
|
|
45
|
+
* @param {*} [options] Override http request option.
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
getResponseMessage: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
+
/**
|
|
50
|
+
* Returns a list of messages you have previously created. The messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
51
|
+
* @summary List messages
|
|
52
|
+
* @param {string} [authorization] Bearer Token
|
|
53
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
54
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
55
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
56
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
57
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
58
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
59
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
60
|
+
* @param {*} [options] Override http request option.
|
|
61
|
+
* @throws {RequiredError}
|
|
62
|
+
*/
|
|
63
|
+
listAllMessages: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
64
|
+
/**
|
|
65
|
+
* Returns a list of requests messages you have previously created. The requests messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
66
|
+
* @summary List requests messages
|
|
67
|
+
* @param {string} [authorization] Bearer Token
|
|
68
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
69
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
70
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
71
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
72
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
73
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
74
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
75
|
+
* @param {*} [options] Override http request option.
|
|
76
|
+
* @throws {RequiredError}
|
|
77
|
+
*/
|
|
78
|
+
listRequestsMessages: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
/**
|
|
80
|
+
* Returns a list of responses messages you have previously created. The responses messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
81
|
+
* @summary List responses messages
|
|
82
|
+
* @param {string} [authorization] Bearer Token
|
|
83
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
84
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
85
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
86
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
87
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
88
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
89
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
90
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
listResponsesMessages: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
|
+
/**
|
|
95
|
+
* Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
96
|
+
* @summary Update the request message
|
|
97
|
+
* @param {string} code Unique identifier for the object.
|
|
98
|
+
* @param {UpdateRequestMessageRequestDto} updateRequestMessageRequestDto
|
|
99
|
+
* @param {string} [authorization] Bearer Token
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
updateRequestMessage: (code: string, updateRequestMessageRequestDto: UpdateRequestMessageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
104
|
+
/**
|
|
105
|
+
* Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
106
|
+
* @summary Update the request message
|
|
107
|
+
* @param {string} code Unique identifier for the object.
|
|
108
|
+
* @param {UpdateResponseMessageRequestDto} updateResponseMessageRequestDto
|
|
109
|
+
* @param {string} [authorization] Bearer Token
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
updateResponseMessage: (code: string, updateResponseMessageRequestDto: UpdateResponseMessageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
114
|
+
};
|
|
115
|
+
/**
|
|
116
|
+
* MessagesApi - functional programming interface
|
|
117
|
+
* @export
|
|
118
|
+
*/
|
|
119
|
+
export declare const MessagesApiFp: (configuration?: Configuration) => {
|
|
120
|
+
/**
|
|
121
|
+
* Retrieves the details of the request message that was previously created. Supply the unique request message code that was returned when you created it and Emil Api will return the corresponding request message information.
|
|
122
|
+
* @summary Retrieve the request message
|
|
123
|
+
* @param {string} code Unique identifier for the object.
|
|
124
|
+
* @param {string} [authorization] Bearer Token
|
|
125
|
+
* @param {string} [expand]
|
|
126
|
+
* @param {*} [options] Override http request option.
|
|
127
|
+
* @throws {RequiredError}
|
|
128
|
+
*/
|
|
129
|
+
getRequestMessage(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRequestMessageResponseClass>>;
|
|
130
|
+
/**
|
|
131
|
+
* Retrieves the details of the response message that was previously created. Supply the unique response message code that was returned when you created it and Emil Api will return the corresponding response message information.
|
|
132
|
+
* @summary Retrieve the response message
|
|
133
|
+
* @param {string} code Unique identifier for the object.
|
|
134
|
+
* @param {string} [authorization] Bearer Token
|
|
135
|
+
* @param {string} [expand]
|
|
136
|
+
* @param {*} [options] Override http request option.
|
|
137
|
+
* @throws {RequiredError}
|
|
138
|
+
*/
|
|
139
|
+
getResponseMessage(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetResponseMessageResponseClass>>;
|
|
140
|
+
/**
|
|
141
|
+
* Returns a list of messages you have previously created. The messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
142
|
+
* @summary List messages
|
|
143
|
+
* @param {string} [authorization] Bearer Token
|
|
144
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
145
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
146
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
147
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
148
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
149
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
150
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
151
|
+
* @param {*} [options] Override http request option.
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
*/
|
|
154
|
+
listAllMessages(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAllMessagesResponseClass>>;
|
|
155
|
+
/**
|
|
156
|
+
* Returns a list of requests messages you have previously created. The requests messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
157
|
+
* @summary List requests messages
|
|
158
|
+
* @param {string} [authorization] Bearer Token
|
|
159
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
160
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
161
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
162
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
163
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
164
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
165
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
*/
|
|
169
|
+
listRequestsMessages(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRequestsMessagesResponseClass>>;
|
|
170
|
+
/**
|
|
171
|
+
* Returns a list of responses messages you have previously created. The responses messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
172
|
+
* @summary List responses messages
|
|
173
|
+
* @param {string} [authorization] Bearer Token
|
|
174
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
175
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
176
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
177
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
178
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
179
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
180
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
181
|
+
* @param {*} [options] Override http request option.
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
*/
|
|
184
|
+
listResponsesMessages(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListResponsesMessagesResponseClass>>;
|
|
185
|
+
/**
|
|
186
|
+
* Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
187
|
+
* @summary Update the request message
|
|
188
|
+
* @param {string} code Unique identifier for the object.
|
|
189
|
+
* @param {UpdateRequestMessageRequestDto} updateRequestMessageRequestDto
|
|
190
|
+
* @param {string} [authorization] Bearer Token
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
*/
|
|
194
|
+
updateRequestMessage(code: string, updateRequestMessageRequestDto: UpdateRequestMessageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateRequestMessageResponseClass>>;
|
|
195
|
+
/**
|
|
196
|
+
* Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
197
|
+
* @summary Update the request message
|
|
198
|
+
* @param {string} code Unique identifier for the object.
|
|
199
|
+
* @param {UpdateResponseMessageRequestDto} updateResponseMessageRequestDto
|
|
200
|
+
* @param {string} [authorization] Bearer Token
|
|
201
|
+
* @param {*} [options] Override http request option.
|
|
202
|
+
* @throws {RequiredError}
|
|
203
|
+
*/
|
|
204
|
+
updateResponseMessage(code: string, updateResponseMessageRequestDto: UpdateResponseMessageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateResponseMessageResponseClass>>;
|
|
205
|
+
};
|
|
206
|
+
/**
|
|
207
|
+
* MessagesApi - factory interface
|
|
208
|
+
* @export
|
|
209
|
+
*/
|
|
210
|
+
export declare const MessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
211
|
+
/**
|
|
212
|
+
* Retrieves the details of the request message that was previously created. Supply the unique request message code that was returned when you created it and Emil Api will return the corresponding request message information.
|
|
213
|
+
* @summary Retrieve the request message
|
|
214
|
+
* @param {string} code Unique identifier for the object.
|
|
215
|
+
* @param {string} [authorization] Bearer Token
|
|
216
|
+
* @param {string} [expand]
|
|
217
|
+
* @param {*} [options] Override http request option.
|
|
218
|
+
* @throws {RequiredError}
|
|
219
|
+
*/
|
|
220
|
+
getRequestMessage(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetRequestMessageResponseClass>;
|
|
221
|
+
/**
|
|
222
|
+
* Retrieves the details of the response message that was previously created. Supply the unique response message code that was returned when you created it and Emil Api will return the corresponding response message information.
|
|
223
|
+
* @summary Retrieve the response message
|
|
224
|
+
* @param {string} code Unique identifier for the object.
|
|
225
|
+
* @param {string} [authorization] Bearer Token
|
|
226
|
+
* @param {string} [expand]
|
|
227
|
+
* @param {*} [options] Override http request option.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
getResponseMessage(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetResponseMessageResponseClass>;
|
|
231
|
+
/**
|
|
232
|
+
* Returns a list of messages you have previously created. The messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
233
|
+
* @summary List messages
|
|
234
|
+
* @param {string} [authorization] Bearer Token
|
|
235
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
236
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
237
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
238
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
239
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
240
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
241
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
242
|
+
* @param {*} [options] Override http request option.
|
|
243
|
+
* @throws {RequiredError}
|
|
244
|
+
*/
|
|
245
|
+
listAllMessages(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListAllMessagesResponseClass>;
|
|
246
|
+
/**
|
|
247
|
+
* Returns a list of requests messages you have previously created. The requests messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
248
|
+
* @summary List requests messages
|
|
249
|
+
* @param {string} [authorization] Bearer Token
|
|
250
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
252
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
253
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
255
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
256
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
257
|
+
* @param {*} [options] Override http request option.
|
|
258
|
+
* @throws {RequiredError}
|
|
259
|
+
*/
|
|
260
|
+
listRequestsMessages(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListRequestsMessagesResponseClass>;
|
|
261
|
+
/**
|
|
262
|
+
* Returns a list of responses messages you have previously created. The responses messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
263
|
+
* @summary List responses messages
|
|
264
|
+
* @param {string} [authorization] Bearer Token
|
|
265
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
266
|
+
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
267
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
268
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
269
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
270
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
271
|
+
* @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
272
|
+
* @param {*} [options] Override http request option.
|
|
273
|
+
* @throws {RequiredError}
|
|
274
|
+
*/
|
|
275
|
+
listResponsesMessages(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListResponsesMessagesResponseClass>;
|
|
276
|
+
/**
|
|
277
|
+
* Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
278
|
+
* @summary Update the request message
|
|
279
|
+
* @param {string} code Unique identifier for the object.
|
|
280
|
+
* @param {UpdateRequestMessageRequestDto} updateRequestMessageRequestDto
|
|
281
|
+
* @param {string} [authorization] Bearer Token
|
|
282
|
+
* @param {*} [options] Override http request option.
|
|
283
|
+
* @throws {RequiredError}
|
|
284
|
+
*/
|
|
285
|
+
updateRequestMessage(code: string, updateRequestMessageRequestDto: UpdateRequestMessageRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateRequestMessageResponseClass>;
|
|
286
|
+
/**
|
|
287
|
+
* Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
288
|
+
* @summary Update the request message
|
|
289
|
+
* @param {string} code Unique identifier for the object.
|
|
290
|
+
* @param {UpdateResponseMessageRequestDto} updateResponseMessageRequestDto
|
|
291
|
+
* @param {string} [authorization] Bearer Token
|
|
292
|
+
* @param {*} [options] Override http request option.
|
|
293
|
+
* @throws {RequiredError}
|
|
294
|
+
*/
|
|
295
|
+
updateResponseMessage(code: string, updateResponseMessageRequestDto: UpdateResponseMessageRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateResponseMessageResponseClass>;
|
|
296
|
+
};
|
|
297
|
+
/**
|
|
298
|
+
* Request parameters for getRequestMessage operation in MessagesApi.
|
|
299
|
+
* @export
|
|
300
|
+
* @interface MessagesApiGetRequestMessageRequest
|
|
301
|
+
*/
|
|
302
|
+
export interface MessagesApiGetRequestMessageRequest {
|
|
303
|
+
/**
|
|
304
|
+
* Unique identifier for the object.
|
|
305
|
+
* @type {string}
|
|
306
|
+
* @memberof MessagesApiGetRequestMessage
|
|
307
|
+
*/
|
|
308
|
+
readonly code: string;
|
|
309
|
+
/**
|
|
310
|
+
* Bearer Token
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof MessagesApiGetRequestMessage
|
|
313
|
+
*/
|
|
314
|
+
readonly authorization?: string;
|
|
315
|
+
/**
|
|
316
|
+
*
|
|
317
|
+
* @type {string}
|
|
318
|
+
* @memberof MessagesApiGetRequestMessage
|
|
319
|
+
*/
|
|
320
|
+
readonly expand?: string;
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* Request parameters for getResponseMessage operation in MessagesApi.
|
|
324
|
+
* @export
|
|
325
|
+
* @interface MessagesApiGetResponseMessageRequest
|
|
326
|
+
*/
|
|
327
|
+
export interface MessagesApiGetResponseMessageRequest {
|
|
328
|
+
/**
|
|
329
|
+
* Unique identifier for the object.
|
|
330
|
+
* @type {string}
|
|
331
|
+
* @memberof MessagesApiGetResponseMessage
|
|
332
|
+
*/
|
|
333
|
+
readonly code: string;
|
|
334
|
+
/**
|
|
335
|
+
* Bearer Token
|
|
336
|
+
* @type {string}
|
|
337
|
+
* @memberof MessagesApiGetResponseMessage
|
|
338
|
+
*/
|
|
339
|
+
readonly authorization?: string;
|
|
340
|
+
/**
|
|
341
|
+
*
|
|
342
|
+
* @type {string}
|
|
343
|
+
* @memberof MessagesApiGetResponseMessage
|
|
344
|
+
*/
|
|
345
|
+
readonly expand?: string;
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* Request parameters for listAllMessages operation in MessagesApi.
|
|
349
|
+
* @export
|
|
350
|
+
* @interface MessagesApiListAllMessagesRequest
|
|
351
|
+
*/
|
|
352
|
+
export interface MessagesApiListAllMessagesRequest {
|
|
353
|
+
/**
|
|
354
|
+
* Bearer Token
|
|
355
|
+
* @type {string}
|
|
356
|
+
* @memberof MessagesApiListAllMessages
|
|
357
|
+
*/
|
|
358
|
+
readonly authorization?: string;
|
|
359
|
+
/**
|
|
360
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
361
|
+
* @type {any}
|
|
362
|
+
* @memberof MessagesApiListAllMessages
|
|
363
|
+
*/
|
|
364
|
+
readonly pageSize?: any;
|
|
365
|
+
/**
|
|
366
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
367
|
+
* @type {any}
|
|
368
|
+
* @memberof MessagesApiListAllMessages
|
|
369
|
+
*/
|
|
370
|
+
readonly pageToken?: any;
|
|
371
|
+
/**
|
|
372
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
373
|
+
* @type {any}
|
|
374
|
+
* @memberof MessagesApiListAllMessages
|
|
375
|
+
*/
|
|
376
|
+
readonly filter?: any;
|
|
377
|
+
/**
|
|
378
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
379
|
+
* @type {any}
|
|
380
|
+
* @memberof MessagesApiListAllMessages
|
|
381
|
+
*/
|
|
382
|
+
readonly search?: any;
|
|
383
|
+
/**
|
|
384
|
+
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
385
|
+
* @type {any}
|
|
386
|
+
* @memberof MessagesApiListAllMessages
|
|
387
|
+
*/
|
|
388
|
+
readonly order?: any;
|
|
389
|
+
/**
|
|
390
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
391
|
+
* @type {any}
|
|
392
|
+
* @memberof MessagesApiListAllMessages
|
|
393
|
+
*/
|
|
394
|
+
readonly expand?: any;
|
|
395
|
+
/**
|
|
396
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
397
|
+
* @type {any}
|
|
398
|
+
* @memberof MessagesApiListAllMessages
|
|
399
|
+
*/
|
|
400
|
+
readonly filters?: any;
|
|
401
|
+
}
|
|
402
|
+
/**
|
|
403
|
+
* Request parameters for listRequestsMessages operation in MessagesApi.
|
|
404
|
+
* @export
|
|
405
|
+
* @interface MessagesApiListRequestsMessagesRequest
|
|
406
|
+
*/
|
|
407
|
+
export interface MessagesApiListRequestsMessagesRequest {
|
|
408
|
+
/**
|
|
409
|
+
* Bearer Token
|
|
410
|
+
* @type {string}
|
|
411
|
+
* @memberof MessagesApiListRequestsMessages
|
|
412
|
+
*/
|
|
413
|
+
readonly authorization?: string;
|
|
414
|
+
/**
|
|
415
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
416
|
+
* @type {any}
|
|
417
|
+
* @memberof MessagesApiListRequestsMessages
|
|
418
|
+
*/
|
|
419
|
+
readonly pageSize?: any;
|
|
420
|
+
/**
|
|
421
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
422
|
+
* @type {any}
|
|
423
|
+
* @memberof MessagesApiListRequestsMessages
|
|
424
|
+
*/
|
|
425
|
+
readonly pageToken?: any;
|
|
426
|
+
/**
|
|
427
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
428
|
+
* @type {any}
|
|
429
|
+
* @memberof MessagesApiListRequestsMessages
|
|
430
|
+
*/
|
|
431
|
+
readonly filter?: any;
|
|
432
|
+
/**
|
|
433
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
434
|
+
* @type {any}
|
|
435
|
+
* @memberof MessagesApiListRequestsMessages
|
|
436
|
+
*/
|
|
437
|
+
readonly search?: any;
|
|
438
|
+
/**
|
|
439
|
+
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
440
|
+
* @type {any}
|
|
441
|
+
* @memberof MessagesApiListRequestsMessages
|
|
442
|
+
*/
|
|
443
|
+
readonly order?: any;
|
|
444
|
+
/**
|
|
445
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
446
|
+
* @type {any}
|
|
447
|
+
* @memberof MessagesApiListRequestsMessages
|
|
448
|
+
*/
|
|
449
|
+
readonly expand?: any;
|
|
450
|
+
/**
|
|
451
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
452
|
+
* @type {any}
|
|
453
|
+
* @memberof MessagesApiListRequestsMessages
|
|
454
|
+
*/
|
|
455
|
+
readonly filters?: any;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* Request parameters for listResponsesMessages operation in MessagesApi.
|
|
459
|
+
* @export
|
|
460
|
+
* @interface MessagesApiListResponsesMessagesRequest
|
|
461
|
+
*/
|
|
462
|
+
export interface MessagesApiListResponsesMessagesRequest {
|
|
463
|
+
/**
|
|
464
|
+
* Bearer Token
|
|
465
|
+
* @type {string}
|
|
466
|
+
* @memberof MessagesApiListResponsesMessages
|
|
467
|
+
*/
|
|
468
|
+
readonly authorization?: string;
|
|
469
|
+
/**
|
|
470
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
471
|
+
* @type {any}
|
|
472
|
+
* @memberof MessagesApiListResponsesMessages
|
|
473
|
+
*/
|
|
474
|
+
readonly pageSize?: any;
|
|
475
|
+
/**
|
|
476
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
477
|
+
* @type {any}
|
|
478
|
+
* @memberof MessagesApiListResponsesMessages
|
|
479
|
+
*/
|
|
480
|
+
readonly pageToken?: any;
|
|
481
|
+
/**
|
|
482
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
483
|
+
* @type {any}
|
|
484
|
+
* @memberof MessagesApiListResponsesMessages
|
|
485
|
+
*/
|
|
486
|
+
readonly filter?: any;
|
|
487
|
+
/**
|
|
488
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
489
|
+
* @type {any}
|
|
490
|
+
* @memberof MessagesApiListResponsesMessages
|
|
491
|
+
*/
|
|
492
|
+
readonly search?: any;
|
|
493
|
+
/**
|
|
494
|
+
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
495
|
+
* @type {any}
|
|
496
|
+
* @memberof MessagesApiListResponsesMessages
|
|
497
|
+
*/
|
|
498
|
+
readonly order?: any;
|
|
499
|
+
/**
|
|
500
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
501
|
+
* @type {any}
|
|
502
|
+
* @memberof MessagesApiListResponsesMessages
|
|
503
|
+
*/
|
|
504
|
+
readonly expand?: any;
|
|
505
|
+
/**
|
|
506
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
507
|
+
* @type {any}
|
|
508
|
+
* @memberof MessagesApiListResponsesMessages
|
|
509
|
+
*/
|
|
510
|
+
readonly filters?: any;
|
|
511
|
+
}
|
|
512
|
+
/**
|
|
513
|
+
* Request parameters for updateRequestMessage operation in MessagesApi.
|
|
514
|
+
* @export
|
|
515
|
+
* @interface MessagesApiUpdateRequestMessageRequest
|
|
516
|
+
*/
|
|
517
|
+
export interface MessagesApiUpdateRequestMessageRequest {
|
|
518
|
+
/**
|
|
519
|
+
* Unique identifier for the object.
|
|
520
|
+
* @type {string}
|
|
521
|
+
* @memberof MessagesApiUpdateRequestMessage
|
|
522
|
+
*/
|
|
523
|
+
readonly code: string;
|
|
524
|
+
/**
|
|
525
|
+
*
|
|
526
|
+
* @type {UpdateRequestMessageRequestDto}
|
|
527
|
+
* @memberof MessagesApiUpdateRequestMessage
|
|
528
|
+
*/
|
|
529
|
+
readonly updateRequestMessageRequestDto: UpdateRequestMessageRequestDto;
|
|
530
|
+
/**
|
|
531
|
+
* Bearer Token
|
|
532
|
+
* @type {string}
|
|
533
|
+
* @memberof MessagesApiUpdateRequestMessage
|
|
534
|
+
*/
|
|
535
|
+
readonly authorization?: string;
|
|
536
|
+
}
|
|
537
|
+
/**
|
|
538
|
+
* Request parameters for updateResponseMessage operation in MessagesApi.
|
|
539
|
+
* @export
|
|
540
|
+
* @interface MessagesApiUpdateResponseMessageRequest
|
|
541
|
+
*/
|
|
542
|
+
export interface MessagesApiUpdateResponseMessageRequest {
|
|
543
|
+
/**
|
|
544
|
+
* Unique identifier for the object.
|
|
545
|
+
* @type {string}
|
|
546
|
+
* @memberof MessagesApiUpdateResponseMessage
|
|
547
|
+
*/
|
|
548
|
+
readonly code: string;
|
|
549
|
+
/**
|
|
550
|
+
*
|
|
551
|
+
* @type {UpdateResponseMessageRequestDto}
|
|
552
|
+
* @memberof MessagesApiUpdateResponseMessage
|
|
553
|
+
*/
|
|
554
|
+
readonly updateResponseMessageRequestDto: UpdateResponseMessageRequestDto;
|
|
555
|
+
/**
|
|
556
|
+
* Bearer Token
|
|
557
|
+
* @type {string}
|
|
558
|
+
* @memberof MessagesApiUpdateResponseMessage
|
|
559
|
+
*/
|
|
560
|
+
readonly authorization?: string;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* MessagesApi - object-oriented interface
|
|
564
|
+
* @export
|
|
565
|
+
* @class MessagesApi
|
|
566
|
+
* @extends {BaseAPI}
|
|
567
|
+
*/
|
|
568
|
+
export declare class MessagesApi extends BaseAPI {
|
|
569
|
+
/**
|
|
570
|
+
* Retrieves the details of the request message that was previously created. Supply the unique request message code that was returned when you created it and Emil Api will return the corresponding request message information.
|
|
571
|
+
* @summary Retrieve the request message
|
|
572
|
+
* @param {MessagesApiGetRequestMessageRequest} requestParameters Request parameters.
|
|
573
|
+
* @param {*} [options] Override http request option.
|
|
574
|
+
* @throws {RequiredError}
|
|
575
|
+
* @memberof MessagesApi
|
|
576
|
+
*/
|
|
577
|
+
getRequestMessage(requestParameters: MessagesApiGetRequestMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRequestMessageResponseClass, any>>;
|
|
578
|
+
/**
|
|
579
|
+
* Retrieves the details of the response message that was previously created. Supply the unique response message code that was returned when you created it and Emil Api will return the corresponding response message information.
|
|
580
|
+
* @summary Retrieve the response message
|
|
581
|
+
* @param {MessagesApiGetResponseMessageRequest} requestParameters Request parameters.
|
|
582
|
+
* @param {*} [options] Override http request option.
|
|
583
|
+
* @throws {RequiredError}
|
|
584
|
+
* @memberof MessagesApi
|
|
585
|
+
*/
|
|
586
|
+
getResponseMessage(requestParameters: MessagesApiGetResponseMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetResponseMessageResponseClass, any>>;
|
|
587
|
+
/**
|
|
588
|
+
* Returns a list of messages you have previously created. The messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
589
|
+
* @summary List messages
|
|
590
|
+
* @param {MessagesApiListAllMessagesRequest} requestParameters Request parameters.
|
|
591
|
+
* @param {*} [options] Override http request option.
|
|
592
|
+
* @throws {RequiredError}
|
|
593
|
+
* @memberof MessagesApi
|
|
594
|
+
*/
|
|
595
|
+
listAllMessages(requestParameters?: MessagesApiListAllMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAllMessagesResponseClass, any>>;
|
|
596
|
+
/**
|
|
597
|
+
* Returns a list of requests messages you have previously created. The requests messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
598
|
+
* @summary List requests messages
|
|
599
|
+
* @param {MessagesApiListRequestsMessagesRequest} requestParameters Request parameters.
|
|
600
|
+
* @param {*} [options] Override http request option.
|
|
601
|
+
* @throws {RequiredError}
|
|
602
|
+
* @memberof MessagesApi
|
|
603
|
+
*/
|
|
604
|
+
listRequestsMessages(requestParameters?: MessagesApiListRequestsMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRequestsMessagesResponseClass, any>>;
|
|
605
|
+
/**
|
|
606
|
+
* Returns a list of responses messages you have previously created. The responses messages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
607
|
+
* @summary List responses messages
|
|
608
|
+
* @param {MessagesApiListResponsesMessagesRequest} requestParameters Request parameters.
|
|
609
|
+
* @param {*} [options] Override http request option.
|
|
610
|
+
* @throws {RequiredError}
|
|
611
|
+
* @memberof MessagesApi
|
|
612
|
+
*/
|
|
613
|
+
listResponsesMessages(requestParameters?: MessagesApiListResponsesMessagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListResponsesMessagesResponseClass, any>>;
|
|
614
|
+
/**
|
|
615
|
+
* Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
616
|
+
* @summary Update the request message
|
|
617
|
+
* @param {MessagesApiUpdateRequestMessageRequest} requestParameters Request parameters.
|
|
618
|
+
* @param {*} [options] Override http request option.
|
|
619
|
+
* @throws {RequiredError}
|
|
620
|
+
* @memberof MessagesApi
|
|
621
|
+
*/
|
|
622
|
+
updateRequestMessage(requestParameters: MessagesApiUpdateRequestMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateRequestMessageResponseClass, any>>;
|
|
623
|
+
/**
|
|
624
|
+
* Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
625
|
+
* @summary Update the request message
|
|
626
|
+
* @param {MessagesApiUpdateResponseMessageRequest} requestParameters Request parameters.
|
|
627
|
+
* @param {*} [options] Override http request option.
|
|
628
|
+
* @throws {RequiredError}
|
|
629
|
+
* @memberof MessagesApi
|
|
630
|
+
*/
|
|
631
|
+
updateResponseMessage(requestParameters: MessagesApiUpdateResponseMessageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateResponseMessageResponseClass, any>>;
|
|
632
|
+
}
|