@pidginhost/sdk 0.3.0 → 0.6.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.
@@ -5,21 +5,13 @@ All URIs are relative to *https://www.pidginhost.com*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**supportDepartmentsList**](#supportdepartmentslist) | **GET** /api/support/departments/ | |
8
- |[**supportDepartmentsList2**](#supportdepartmentslist2) | **GET** /api/v1/support/departments/ | |
9
8
  |[**supportTicketsCloseCreate**](#supportticketsclosecreate) | **POST** /api/support/tickets/{id}/close/ | |
10
- |[**supportTicketsCloseCreate2**](#supportticketsclosecreate2) | **POST** /api/v1/support/tickets/{id}/close/ | |
11
9
  |[**supportTicketsCreate**](#supportticketscreate) | **POST** /api/support/tickets/ | |
12
- |[**supportTicketsCreate2**](#supportticketscreate2) | **POST** /api/v1/support/tickets/ | |
13
10
  |[**supportTicketsList**](#supportticketslist) | **GET** /api/support/tickets/ | |
14
- |[**supportTicketsList2**](#supportticketslist2) | **GET** /api/v1/support/tickets/ | |
15
11
  |[**supportTicketsMessagesAttachmentRetrieve**](#supportticketsmessagesattachmentretrieve) | **GET** /api/support/tickets/{id}/messages/{message_id}/attachment/ | |
16
- |[**supportTicketsMessagesAttachmentRetrieve2**](#supportticketsmessagesattachmentretrieve2) | **GET** /api/v1/support/tickets/{id}/messages/{message_id}/attachment/ | |
17
12
  |[**supportTicketsReopenCreate**](#supportticketsreopencreate) | **POST** /api/support/tickets/{id}/reopen/ | |
18
- |[**supportTicketsReopenCreate2**](#supportticketsreopencreate2) | **POST** /api/v1/support/tickets/{id}/reopen/ | |
19
13
  |[**supportTicketsReplyCreate**](#supportticketsreplycreate) | **POST** /api/support/tickets/{id}/reply/ | |
20
- |[**supportTicketsReplyCreate2**](#supportticketsreplycreate2) | **POST** /api/v1/support/tickets/{id}/reply/ | |
21
14
  |[**supportTicketsRetrieve**](#supportticketsretrieve) | **GET** /api/support/tickets/{id}/ | |
22
- |[**supportTicketsRetrieve2**](#supportticketsretrieve2) | **GET** /api/v1/support/tickets/{id}/ | |
23
15
 
24
16
  # **supportDepartmentsList**
25
17
  > Array<Department> supportDepartmentsList()
@@ -44,50 +36,6 @@ const { status, data } = await apiInstance.supportDepartmentsList();
44
36
  This endpoint does not have any parameters.
45
37
 
46
38
 
47
- ### Return type
48
-
49
- **Array<Department>**
50
-
51
- ### Authorization
52
-
53
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
54
-
55
- ### HTTP request headers
56
-
57
- - **Content-Type**: Not defined
58
- - **Accept**: application/json
59
-
60
-
61
- ### HTTP response details
62
- | Status code | Description | Response headers |
63
- |-------------|-------------|------------------|
64
- |**200** | | - |
65
-
66
- [[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)
67
-
68
- # **supportDepartmentsList2**
69
- > Array<Department> supportDepartmentsList2()
70
-
71
- List available support departments.
72
-
73
- ### Example
74
-
75
- ```typescript
76
- import {
77
- SupportApi,
78
- Configuration
79
- } from '@pidginhost/sdk';
80
-
81
- const configuration = new Configuration();
82
- const apiInstance = new SupportApi(configuration);
83
-
84
- const { status, data } = await apiInstance.supportDepartmentsList2();
85
- ```
86
-
87
- ### Parameters
88
- This endpoint does not have any parameters.
89
-
90
-
91
39
  ### Return type
92
40
 
93
41
  **Array<Department>**
@@ -139,57 +87,6 @@ const { status, data } = await apiInstance.supportTicketsCloseCreate(
139
87
  | **id** | [**string**] | | defaults to undefined|
140
88
 
141
89
 
142
- ### Return type
143
-
144
- **TicketCloseResponse**
145
-
146
- ### Authorization
147
-
148
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
149
-
150
- ### HTTP request headers
151
-
152
- - **Content-Type**: Not defined
153
- - **Accept**: application/json
154
-
155
-
156
- ### HTTP response details
157
- | Status code | Description | Response headers |
158
- |-------------|-------------|------------------|
159
- |**200** | | - |
160
-
161
- [[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)
162
-
163
- # **supportTicketsCloseCreate2**
164
- > TicketCloseResponse supportTicketsCloseCreate2()
165
-
166
- Close a ticket.
167
-
168
- ### Example
169
-
170
- ```typescript
171
- import {
172
- SupportApi,
173
- Configuration
174
- } from '@pidginhost/sdk';
175
-
176
- const configuration = new Configuration();
177
- const apiInstance = new SupportApi(configuration);
178
-
179
- let id: string; // (default to undefined)
180
-
181
- const { status, data } = await apiInstance.supportTicketsCloseCreate2(
182
- id
183
- );
184
- ```
185
-
186
- ### Parameters
187
-
188
- |Name | Type | Description | Notes|
189
- |------------- | ------------- | ------------- | -------------|
190
- | **id** | [**string**] | | defaults to undefined|
191
-
192
-
193
90
  ### Return type
194
91
 
195
92
  **TicketCloseResponse**
@@ -242,58 +139,6 @@ const { status, data } = await apiInstance.supportTicketsCreate(
242
139
  | **ticketCreate** | **TicketCreate**| | |
243
140
 
244
141
 
245
- ### Return type
246
-
247
- **TicketDetail**
248
-
249
- ### Authorization
250
-
251
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
252
-
253
- ### HTTP request headers
254
-
255
- - **Content-Type**: application/json
256
- - **Accept**: application/json
257
-
258
-
259
- ### HTTP response details
260
- | Status code | Description | Response headers |
261
- |-------------|-------------|------------------|
262
- |**201** | | - |
263
-
264
- [[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)
265
-
266
- # **supportTicketsCreate2**
267
- > TicketDetail supportTicketsCreate2(ticketCreate)
268
-
269
- Create a new support ticket.
270
-
271
- ### Example
272
-
273
- ```typescript
274
- import {
275
- SupportApi,
276
- Configuration,
277
- TicketCreate
278
- } from '@pidginhost/sdk';
279
-
280
- const configuration = new Configuration();
281
- const apiInstance = new SupportApi(configuration);
282
-
283
- let ticketCreate: TicketCreate; //
284
-
285
- const { status, data } = await apiInstance.supportTicketsCreate2(
286
- ticketCreate
287
- );
288
- ```
289
-
290
- ### Parameters
291
-
292
- |Name | Type | Description | Notes|
293
- |------------- | ------------- | ------------- | -------------|
294
- | **ticketCreate** | **TicketCreate**| | |
295
-
296
-
297
142
  ### Return type
298
143
 
299
144
  **TicketDetail**
@@ -345,57 +190,6 @@ const { status, data } = await apiInstance.supportTicketsList(
345
190
  | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
346
191
 
347
192
 
348
- ### Return type
349
-
350
- **PaginatedTicketListList**
351
-
352
- ### Authorization
353
-
354
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
355
-
356
- ### HTTP request headers
357
-
358
- - **Content-Type**: Not defined
359
- - **Accept**: application/json
360
-
361
-
362
- ### HTTP response details
363
- | Status code | Description | Response headers |
364
- |-------------|-------------|------------------|
365
- |**200** | | - |
366
-
367
- [[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)
368
-
369
- # **supportTicketsList2**
370
- > PaginatedTicketListList supportTicketsList2()
371
-
372
- List, create, and manage support tickets.
373
-
374
- ### Example
375
-
376
- ```typescript
377
- import {
378
- SupportApi,
379
- Configuration
380
- } from '@pidginhost/sdk';
381
-
382
- const configuration = new Configuration();
383
- const apiInstance = new SupportApi(configuration);
384
-
385
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
386
-
387
- const { status, data } = await apiInstance.supportTicketsList2(
388
- page
389
- );
390
- ```
391
-
392
- ### Parameters
393
-
394
- |Name | Type | Description | Notes|
395
- |------------- | ------------- | ------------- | -------------|
396
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
397
-
398
-
399
193
  ### Return type
400
194
 
401
195
  **PaginatedTicketListList**
@@ -450,60 +244,6 @@ const { status, data } = await apiInstance.supportTicketsMessagesAttachmentRetri
450
244
  | **messageId** | [**string**] | | defaults to undefined|
451
245
 
452
246
 
453
- ### Return type
454
-
455
- **File**
456
-
457
- ### Authorization
458
-
459
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
460
-
461
- ### HTTP request headers
462
-
463
- - **Content-Type**: Not defined
464
- - **Accept**: application/json
465
-
466
-
467
- ### HTTP response details
468
- | Status code | Description | Response headers |
469
- |-------------|-------------|------------------|
470
- |**200** | | - |
471
-
472
- [[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)
473
-
474
- # **supportTicketsMessagesAttachmentRetrieve2**
475
- > File supportTicketsMessagesAttachmentRetrieve2()
476
-
477
- Download an attachment from a ticket message.
478
-
479
- ### Example
480
-
481
- ```typescript
482
- import {
483
- SupportApi,
484
- Configuration
485
- } from '@pidginhost/sdk';
486
-
487
- const configuration = new Configuration();
488
- const apiInstance = new SupportApi(configuration);
489
-
490
- let id: string; // (default to undefined)
491
- let messageId: string; // (default to undefined)
492
-
493
- const { status, data } = await apiInstance.supportTicketsMessagesAttachmentRetrieve2(
494
- id,
495
- messageId
496
- );
497
- ```
498
-
499
- ### Parameters
500
-
501
- |Name | Type | Description | Notes|
502
- |------------- | ------------- | ------------- | -------------|
503
- | **id** | [**string**] | | defaults to undefined|
504
- | **messageId** | [**string**] | | defaults to undefined|
505
-
506
-
507
247
  ### Return type
508
248
 
509
249
  **File**
@@ -555,57 +295,6 @@ const { status, data } = await apiInstance.supportTicketsReopenCreate(
555
295
  | **id** | [**string**] | | defaults to undefined|
556
296
 
557
297
 
558
- ### Return type
559
-
560
- **TicketReopenResponse**
561
-
562
- ### Authorization
563
-
564
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
565
-
566
- ### HTTP request headers
567
-
568
- - **Content-Type**: Not defined
569
- - **Accept**: application/json
570
-
571
-
572
- ### HTTP response details
573
- | Status code | Description | Response headers |
574
- |-------------|-------------|------------------|
575
- |**200** | | - |
576
-
577
- [[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)
578
-
579
- # **supportTicketsReopenCreate2**
580
- > TicketReopenResponse supportTicketsReopenCreate2()
581
-
582
- Reopen a closed ticket.
583
-
584
- ### Example
585
-
586
- ```typescript
587
- import {
588
- SupportApi,
589
- Configuration
590
- } from '@pidginhost/sdk';
591
-
592
- const configuration = new Configuration();
593
- const apiInstance = new SupportApi(configuration);
594
-
595
- let id: string; // (default to undefined)
596
-
597
- const { status, data } = await apiInstance.supportTicketsReopenCreate2(
598
- id
599
- );
600
- ```
601
-
602
- ### Parameters
603
-
604
- |Name | Type | Description | Notes|
605
- |------------- | ------------- | ------------- | -------------|
606
- | **id** | [**string**] | | defaults to undefined|
607
-
608
-
609
298
  ### Return type
610
299
 
611
300
  **TicketReopenResponse**
@@ -661,61 +350,6 @@ const { status, data } = await apiInstance.supportTicketsReplyCreate(
661
350
  | **id** | [**string**] | | defaults to undefined|
662
351
 
663
352
 
664
- ### Return type
665
-
666
- **TicketReplyResponse**
667
-
668
- ### Authorization
669
-
670
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
671
-
672
- ### HTTP request headers
673
-
674
- - **Content-Type**: application/json
675
- - **Accept**: application/json
676
-
677
-
678
- ### HTTP response details
679
- | Status code | Description | Response headers |
680
- |-------------|-------------|------------------|
681
- |**201** | | - |
682
-
683
- [[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)
684
-
685
- # **supportTicketsReplyCreate2**
686
- > TicketReplyResponse supportTicketsReplyCreate2(ticketReply)
687
-
688
- Reply to a ticket.
689
-
690
- ### Example
691
-
692
- ```typescript
693
- import {
694
- SupportApi,
695
- Configuration,
696
- TicketReply
697
- } from '@pidginhost/sdk';
698
-
699
- const configuration = new Configuration();
700
- const apiInstance = new SupportApi(configuration);
701
-
702
- let id: string; // (default to undefined)
703
- let ticketReply: TicketReply; //
704
-
705
- const { status, data } = await apiInstance.supportTicketsReplyCreate2(
706
- id,
707
- ticketReply
708
- );
709
- ```
710
-
711
- ### Parameters
712
-
713
- |Name | Type | Description | Notes|
714
- |------------- | ------------- | ------------- | -------------|
715
- | **ticketReply** | **TicketReply**| | |
716
- | **id** | [**string**] | | defaults to undefined|
717
-
718
-
719
353
  ### Return type
720
354
 
721
355
  **TicketReplyResponse**
@@ -788,54 +422,3 @@ const { status, data } = await apiInstance.supportTicketsRetrieve(
788
422
 
789
423
  [[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)
790
424
 
791
- # **supportTicketsRetrieve2**
792
- > TicketDetail supportTicketsRetrieve2()
793
-
794
- List, create, and manage support tickets.
795
-
796
- ### Example
797
-
798
- ```typescript
799
- import {
800
- SupportApi,
801
- Configuration
802
- } from '@pidginhost/sdk';
803
-
804
- const configuration = new Configuration();
805
- const apiInstance = new SupportApi(configuration);
806
-
807
- let id: string; // (default to undefined)
808
-
809
- const { status, data } = await apiInstance.supportTicketsRetrieve2(
810
- id
811
- );
812
- ```
813
-
814
- ### Parameters
815
-
816
- |Name | Type | Description | Notes|
817
- |------------- | ------------- | ------------- | -------------|
818
- | **id** | [**string**] | | defaults to undefined|
819
-
820
-
821
- ### Return type
822
-
823
- **TicketDetail**
824
-
825
- ### Authorization
826
-
827
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
828
-
829
- ### HTTP request headers
830
-
831
- - **Content-Type**: Not defined
832
- - **Accept**: application/json
833
-
834
-
835
- ### HTTP response details
836
- | Status code | Description | Response headers |
837
- |-------------|-------------|------------------|
838
- |**200** | | - |
839
-
840
- [[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)
841
-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pidginhost/sdk",
3
- "version": "0.3.0",
3
+ "version": "0.6.0",
4
4
  "description": "OpenAPI client for @pidginhost/sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {