@connectedxm/admin-sdk 6.6.2 → 6.7.3

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.
@@ -1,71 +0,0 @@
1
- # SupportticketsMessagesApi
2
-
3
- All URIs are relative to *https://admin-api.connected.dev*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**getSupportTicketMessages**](#getsupportticketmessages) | **GET** /supportTickets/{supportTicketId}/messages | Get Support Ticket Messages|
8
-
9
- # **getSupportTicketMessages**
10
- > GetAccountInvitations200Response getSupportTicketMessages()
11
-
12
- Get Support Ticket Messages endpoint
13
-
14
- ### Example
15
-
16
- ```typescript
17
- import {
18
- SupportticketsMessagesApi,
19
- Configuration
20
- } from '@connectedxm/admin-sdk';
21
-
22
- const configuration = new Configuration();
23
- const apiInstance = new SupportticketsMessagesApi(configuration);
24
-
25
- let supportTicketId: string; //The supportTicket identifier (default to undefined)
26
- let page: number; //Page number (optional) (default to 1)
27
- let pageSize: number; //Number of items per page (optional) (default to 25)
28
- let orderBy: string; //Field to order by (optional) (default to undefined)
29
- let search: string; //Search query (optional) (default to undefined)
30
-
31
- const { status, data } = await apiInstance.getSupportTicketMessages(
32
- supportTicketId,
33
- page,
34
- pageSize,
35
- orderBy,
36
- search
37
- );
38
- ```
39
-
40
- ### Parameters
41
-
42
- |Name | Type | Description | Notes|
43
- |------------- | ------------- | ------------- | -------------|
44
- | **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
45
- | **page** | [**number**] | Page number | (optional) defaults to 1|
46
- | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
47
- | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
48
- | **search** | [**string**] | Search query | (optional) defaults to undefined|
49
-
50
-
51
- ### Return type
52
-
53
- **GetAccountInvitations200Response**
54
-
55
- ### Authorization
56
-
57
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
58
-
59
- ### HTTP request headers
60
-
61
- - **Content-Type**: Not defined
62
- - **Accept**: application/json
63
-
64
-
65
- ### HTTP response details
66
- | Status code | Description | Response headers |
67
- |-------------|-------------|------------------|
68
- |**200** | Successful response | - |
69
-
70
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
71
-
@@ -1,71 +0,0 @@
1
- # SupportticketsNotesApi
2
-
3
- All URIs are relative to *https://admin-api.connected.dev*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**getSupportTicketNotes**](#getsupportticketnotes) | **GET** /supportTickets/{supportTicketId}/notes | Get Support Ticket Notes|
8
-
9
- # **getSupportTicketNotes**
10
- > GetAccountInvitations200Response getSupportTicketNotes()
11
-
12
- Get Support Ticket Notes endpoint
13
-
14
- ### Example
15
-
16
- ```typescript
17
- import {
18
- SupportticketsNotesApi,
19
- Configuration
20
- } from '@connectedxm/admin-sdk';
21
-
22
- const configuration = new Configuration();
23
- const apiInstance = new SupportticketsNotesApi(configuration);
24
-
25
- let supportTicketId: string; //The supportTicket identifier (default to undefined)
26
- let page: number; //Page number (optional) (default to 1)
27
- let pageSize: number; //Number of items per page (optional) (default to 25)
28
- let orderBy: string; //Field to order by (optional) (default to undefined)
29
- let search: string; //Search query (optional) (default to undefined)
30
-
31
- const { status, data } = await apiInstance.getSupportTicketNotes(
32
- supportTicketId,
33
- page,
34
- pageSize,
35
- orderBy,
36
- search
37
- );
38
- ```
39
-
40
- ### Parameters
41
-
42
- |Name | Type | Description | Notes|
43
- |------------- | ------------- | ------------- | -------------|
44
- | **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
45
- | **page** | [**number**] | Page number | (optional) defaults to 1|
46
- | **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
47
- | **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
48
- | **search** | [**string**] | Search query | (optional) defaults to undefined|
49
-
50
-
51
- ### Return type
52
-
53
- **GetAccountInvitations200Response**
54
-
55
- ### Authorization
56
-
57
- [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
58
-
59
- ### HTTP request headers
60
-
61
- - **Content-Type**: Not defined
62
- - **Accept**: application/json
63
-
64
-
65
- ### HTTP response details
66
- | Status code | Description | Response headers |
67
- |-------------|-------------|------------------|
68
- |**200** | Successful response | - |
69
-
70
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
71
-