@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,41 +5,23 @@ All URIs are relative to *https://www.pidginhost.com*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**billingDepositsCreate**](#billingdepositscreate) | **POST** /api/billing/deposits/ | |
8
- |[**billingDepositsCreate2**](#billingdepositscreate2) | **POST** /api/v1/billing/deposits/ | |
9
8
  |[**billingDepositsList**](#billingdepositslist) | **GET** /api/billing/deposits/ | |
10
- |[**billingDepositsList2**](#billingdepositslist2) | **GET** /api/v1/billing/deposits/ | |
11
9
  |[**billingDepositsRetrieve**](#billingdepositsretrieve) | **GET** /api/billing/deposits/{id}/ | |
12
- |[**billingDepositsRetrieve2**](#billingdepositsretrieve2) | **GET** /api/v1/billing/deposits/{id}/ | |
13
10
  |[**billingFundsList**](#billingfundslist) | **GET** /api/billing/funds/ | |
14
- |[**billingFundsList2**](#billingfundslist2) | **GET** /api/v1/billing/funds/ | |
15
11
  |[**billingFundsLogList**](#billingfundsloglist) | **GET** /api/billing/funds-log/ | |
16
- |[**billingFundsLogList2**](#billingfundsloglist2) | **GET** /api/v1/billing/funds-log/ | |
17
12
  |[**billingFundsNotificationSettingsCreate**](#billingfundsnotificationsettingscreate) | **POST** /api/billing/funds/notification-settings/ | |
18
- |[**billingFundsNotificationSettingsCreate2**](#billingfundsnotificationsettingscreate2) | **POST** /api/v1/billing/funds/notification-settings/ | |
19
13
  |[**billingInvoicesList**](#billinginvoiceslist) | **GET** /api/billing/invoices/ | |
20
- |[**billingInvoicesList2**](#billinginvoiceslist2) | **GET** /api/v1/billing/invoices/ | |
21
14
  |[**billingInvoicesPayWithFundsCreate**](#billinginvoicespaywithfundscreate) | **POST** /api/billing/invoices/{id}/pay-with-funds/ | |
22
- |[**billingInvoicesPayWithFundsCreate2**](#billinginvoicespaywithfundscreate2) | **POST** /api/v1/billing/invoices/{id}/pay-with-funds/ | |
23
15
  |[**billingInvoicesPdfRetrieve**](#billinginvoicespdfretrieve) | **GET** /api/billing/invoices/{id}/pdf/ | |
24
- |[**billingInvoicesPdfRetrieve2**](#billinginvoicespdfretrieve2) | **GET** /api/v1/billing/invoices/{id}/pdf/ | |
25
16
  |[**billingInvoicesRetrieve**](#billinginvoicesretrieve) | **GET** /api/billing/invoices/{id}/ | |
26
- |[**billingInvoicesRetrieve2**](#billinginvoicesretrieve2) | **GET** /api/v1/billing/invoices/{id}/ | |
27
17
  |[**billingServicesCancelCreate**](#billingservicescancelcreate) | **POST** /api/billing/services/{id}/cancel/ | |
28
- |[**billingServicesCancelCreate2**](#billingservicescancelcreate2) | **POST** /api/v1/billing/services/{id}/cancel/ | |
29
18
  |[**billingServicesChangeBillingCycleCreate**](#billingserviceschangebillingcyclecreate) | **POST** /api/billing/services/{id}/change-billing-cycle/ | |
30
- |[**billingServicesChangeBillingCycleCreate2**](#billingserviceschangebillingcyclecreate2) | **POST** /api/v1/billing/services/{id}/change-billing-cycle/ | |
31
19
  |[**billingServicesChangeCompanyCreate**](#billingserviceschangecompanycreate) | **POST** /api/billing/services/{id}/change-company/ | |
32
- |[**billingServicesChangeCompanyCreate2**](#billingserviceschangecompanycreate2) | **POST** /api/v1/billing/services/{id}/change-company/ | |
33
20
  |[**billingServicesList**](#billingserviceslist) | **GET** /api/billing/services/ | |
34
- |[**billingServicesList2**](#billingserviceslist2) | **GET** /api/v1/billing/services/ | |
35
21
  |[**billingServicesRetrieve**](#billingservicesretrieve) | **GET** /api/billing/services/{id}/ | |
36
- |[**billingServicesRetrieve2**](#billingservicesretrieve2) | **GET** /api/v1/billing/services/{id}/ | |
37
22
  |[**billingServicesToggleAutoPaymentCreate**](#billingservicestoggleautopaymentcreate) | **POST** /api/billing/services/{id}/toggle-auto-payment/ | |
38
- |[**billingServicesToggleAutoPaymentCreate2**](#billingservicestoggleautopaymentcreate2) | **POST** /api/v1/billing/services/{id}/toggle-auto-payment/ | |
39
23
  |[**billingSubscriptionsList**](#billingsubscriptionslist) | **GET** /api/billing/subscriptions/ | |
40
- |[**billingSubscriptionsList2**](#billingsubscriptionslist2) | **GET** /api/v1/billing/subscriptions/ | |
41
24
  |[**billingSubscriptionsRetrieve**](#billingsubscriptionsretrieve) | **GET** /api/billing/subscriptions/{id}/ | |
42
- |[**billingSubscriptionsRetrieve2**](#billingsubscriptionsretrieve2) | **GET** /api/v1/billing/subscriptions/{id}/ | |
43
25
 
44
26
  # **billingDepositsCreate**
45
27
  > Deposit billingDepositsCreate(depositCreate)
@@ -72,58 +54,6 @@ const { status, data } = await apiInstance.billingDepositsCreate(
72
54
  | **depositCreate** | **DepositCreate**| | |
73
55
 
74
56
 
75
- ### Return type
76
-
77
- **Deposit**
78
-
79
- ### Authorization
80
-
81
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
82
-
83
- ### HTTP request headers
84
-
85
- - **Content-Type**: application/json
86
- - **Accept**: application/json
87
-
88
-
89
- ### HTTP response details
90
- | Status code | Description | Response headers |
91
- |-------------|-------------|------------------|
92
- |**201** | | - |
93
-
94
- [[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)
95
-
96
- # **billingDepositsCreate2**
97
- > Deposit billingDepositsCreate2(depositCreate)
98
-
99
- Create a new funds deposit.
100
-
101
- ### Example
102
-
103
- ```typescript
104
- import {
105
- BillingApi,
106
- Configuration,
107
- DepositCreate
108
- } from '@pidginhost/sdk';
109
-
110
- const configuration = new Configuration();
111
- const apiInstance = new BillingApi(configuration);
112
-
113
- let depositCreate: DepositCreate; //
114
-
115
- const { status, data } = await apiInstance.billingDepositsCreate2(
116
- depositCreate
117
- );
118
- ```
119
-
120
- ### Parameters
121
-
122
- |Name | Type | Description | Notes|
123
- |------------- | ------------- | ------------- | -------------|
124
- | **depositCreate** | **DepositCreate**| | |
125
-
126
-
127
57
  ### Return type
128
58
 
129
59
  **Deposit**
@@ -146,864 +76,9 @@ const { status, data } = await apiInstance.billingDepositsCreate2(
146
76
  [[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)
147
77
 
148
78
  # **billingDepositsList**
149
- > PaginatedDepositList billingDepositsList()
150
-
151
- List, create, and retrieve fund deposits.
152
-
153
- ### Example
154
-
155
- ```typescript
156
- import {
157
- BillingApi,
158
- Configuration
159
- } from '@pidginhost/sdk';
160
-
161
- const configuration = new Configuration();
162
- const apiInstance = new BillingApi(configuration);
163
-
164
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
165
-
166
- const { status, data } = await apiInstance.billingDepositsList(
167
- page
168
- );
169
- ```
170
-
171
- ### Parameters
172
-
173
- |Name | Type | Description | Notes|
174
- |------------- | ------------- | ------------- | -------------|
175
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
176
-
177
-
178
- ### Return type
179
-
180
- **PaginatedDepositList**
181
-
182
- ### Authorization
183
-
184
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
185
-
186
- ### HTTP request headers
187
-
188
- - **Content-Type**: Not defined
189
- - **Accept**: application/json
190
-
191
-
192
- ### HTTP response details
193
- | Status code | Description | Response headers |
194
- |-------------|-------------|------------------|
195
- |**200** | | - |
196
-
197
- [[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)
198
-
199
- # **billingDepositsList2**
200
- > PaginatedDepositList billingDepositsList2()
201
-
202
- List, create, and retrieve fund deposits.
203
-
204
- ### Example
205
-
206
- ```typescript
207
- import {
208
- BillingApi,
209
- Configuration
210
- } from '@pidginhost/sdk';
211
-
212
- const configuration = new Configuration();
213
- const apiInstance = new BillingApi(configuration);
214
-
215
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
216
-
217
- const { status, data } = await apiInstance.billingDepositsList2(
218
- page
219
- );
220
- ```
221
-
222
- ### Parameters
223
-
224
- |Name | Type | Description | Notes|
225
- |------------- | ------------- | ------------- | -------------|
226
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
227
-
228
-
229
- ### Return type
230
-
231
- **PaginatedDepositList**
232
-
233
- ### Authorization
234
-
235
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
236
-
237
- ### HTTP request headers
238
-
239
- - **Content-Type**: Not defined
240
- - **Accept**: application/json
241
-
242
-
243
- ### HTTP response details
244
- | Status code | Description | Response headers |
245
- |-------------|-------------|------------------|
246
- |**200** | | - |
247
-
248
- [[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)
249
-
250
- # **billingDepositsRetrieve**
251
- > Deposit billingDepositsRetrieve()
252
-
253
- List, create, and retrieve fund deposits.
254
-
255
- ### Example
256
-
257
- ```typescript
258
- import {
259
- BillingApi,
260
- Configuration
261
- } from '@pidginhost/sdk';
262
-
263
- const configuration = new Configuration();
264
- const apiInstance = new BillingApi(configuration);
265
-
266
- let id: string; // (default to undefined)
267
-
268
- const { status, data } = await apiInstance.billingDepositsRetrieve(
269
- id
270
- );
271
- ```
272
-
273
- ### Parameters
274
-
275
- |Name | Type | Description | Notes|
276
- |------------- | ------------- | ------------- | -------------|
277
- | **id** | [**string**] | | defaults to undefined|
278
-
279
-
280
- ### Return type
281
-
282
- **Deposit**
283
-
284
- ### Authorization
285
-
286
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
287
-
288
- ### HTTP request headers
289
-
290
- - **Content-Type**: Not defined
291
- - **Accept**: application/json
292
-
293
-
294
- ### HTTP response details
295
- | Status code | Description | Response headers |
296
- |-------------|-------------|------------------|
297
- |**200** | | - |
298
-
299
- [[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)
300
-
301
- # **billingDepositsRetrieve2**
302
- > Deposit billingDepositsRetrieve2()
303
-
304
- List, create, and retrieve fund deposits.
305
-
306
- ### Example
307
-
308
- ```typescript
309
- import {
310
- BillingApi,
311
- Configuration
312
- } from '@pidginhost/sdk';
313
-
314
- const configuration = new Configuration();
315
- const apiInstance = new BillingApi(configuration);
316
-
317
- let id: string; // (default to undefined)
318
-
319
- const { status, data } = await apiInstance.billingDepositsRetrieve2(
320
- id
321
- );
322
- ```
323
-
324
- ### Parameters
325
-
326
- |Name | Type | Description | Notes|
327
- |------------- | ------------- | ------------- | -------------|
328
- | **id** | [**string**] | | defaults to undefined|
329
-
330
-
331
- ### Return type
332
-
333
- **Deposit**
334
-
335
- ### Authorization
336
-
337
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
338
-
339
- ### HTTP request headers
340
-
341
- - **Content-Type**: Not defined
342
- - **Accept**: application/json
343
-
344
-
345
- ### HTTP response details
346
- | Status code | Description | Response headers |
347
- |-------------|-------------|------------------|
348
- |**200** | | - |
349
-
350
- [[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)
351
-
352
- # **billingFundsList**
353
- > Array<FundsBalanceResponse> billingFundsList()
354
-
355
- Get current funds balance and notification settings.
356
-
357
- ### Example
358
-
359
- ```typescript
360
- import {
361
- BillingApi,
362
- Configuration
363
- } from '@pidginhost/sdk';
364
-
365
- const configuration = new Configuration();
366
- const apiInstance = new BillingApi(configuration);
367
-
368
- const { status, data } = await apiInstance.billingFundsList();
369
- ```
370
-
371
- ### Parameters
372
- This endpoint does not have any parameters.
373
-
374
-
375
- ### Return type
376
-
377
- **Array<FundsBalanceResponse>**
378
-
379
- ### Authorization
380
-
381
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
382
-
383
- ### HTTP request headers
384
-
385
- - **Content-Type**: Not defined
386
- - **Accept**: application/json
387
-
388
-
389
- ### HTTP response details
390
- | Status code | Description | Response headers |
391
- |-------------|-------------|------------------|
392
- |**200** | | - |
393
-
394
- [[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)
395
-
396
- # **billingFundsList2**
397
- > Array<FundsBalanceResponse> billingFundsList2()
398
-
399
- Get current funds balance and notification settings.
400
-
401
- ### Example
402
-
403
- ```typescript
404
- import {
405
- BillingApi,
406
- Configuration
407
- } from '@pidginhost/sdk';
408
-
409
- const configuration = new Configuration();
410
- const apiInstance = new BillingApi(configuration);
411
-
412
- const { status, data } = await apiInstance.billingFundsList2();
413
- ```
414
-
415
- ### Parameters
416
- This endpoint does not have any parameters.
417
-
418
-
419
- ### Return type
420
-
421
- **Array<FundsBalanceResponse>**
422
-
423
- ### Authorization
424
-
425
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
426
-
427
- ### HTTP request headers
428
-
429
- - **Content-Type**: Not defined
430
- - **Accept**: application/json
431
-
432
-
433
- ### HTTP response details
434
- | Status code | Description | Response headers |
435
- |-------------|-------------|------------------|
436
- |**200** | | - |
437
-
438
- [[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)
439
-
440
- # **billingFundsLogList**
441
- > PaginatedFundsLogList billingFundsLogList()
442
-
443
- List funds log entries for the authenticated user.
444
-
445
- ### Example
446
-
447
- ```typescript
448
- import {
449
- BillingApi,
450
- Configuration
451
- } from '@pidginhost/sdk';
452
-
453
- const configuration = new Configuration();
454
- const apiInstance = new BillingApi(configuration);
455
-
456
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
457
-
458
- const { status, data } = await apiInstance.billingFundsLogList(
459
- page
460
- );
461
- ```
462
-
463
- ### Parameters
464
-
465
- |Name | Type | Description | Notes|
466
- |------------- | ------------- | ------------- | -------------|
467
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
468
-
469
-
470
- ### Return type
471
-
472
- **PaginatedFundsLogList**
473
-
474
- ### Authorization
475
-
476
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
477
-
478
- ### HTTP request headers
479
-
480
- - **Content-Type**: Not defined
481
- - **Accept**: application/json
482
-
483
-
484
- ### HTTP response details
485
- | Status code | Description | Response headers |
486
- |-------------|-------------|------------------|
487
- |**200** | | - |
488
-
489
- [[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)
490
-
491
- # **billingFundsLogList2**
492
- > PaginatedFundsLogList billingFundsLogList2()
493
-
494
- List funds log entries for the authenticated user.
495
-
496
- ### Example
497
-
498
- ```typescript
499
- import {
500
- BillingApi,
501
- Configuration
502
- } from '@pidginhost/sdk';
503
-
504
- const configuration = new Configuration();
505
- const apiInstance = new BillingApi(configuration);
506
-
507
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
508
-
509
- const { status, data } = await apiInstance.billingFundsLogList2(
510
- page
511
- );
512
- ```
513
-
514
- ### Parameters
515
-
516
- |Name | Type | Description | Notes|
517
- |------------- | ------------- | ------------- | -------------|
518
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
519
-
520
-
521
- ### Return type
522
-
523
- **PaginatedFundsLogList**
524
-
525
- ### Authorization
526
-
527
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
528
-
529
- ### HTTP request headers
530
-
531
- - **Content-Type**: Not defined
532
- - **Accept**: application/json
533
-
534
-
535
- ### HTTP response details
536
- | Status code | Description | Response headers |
537
- |-------------|-------------|------------------|
538
- |**200** | | - |
539
-
540
- [[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)
541
-
542
- # **billingFundsNotificationSettingsCreate**
543
- > NotificationSettingsResponse billingFundsNotificationSettingsCreate(lowBalanceSettings)
544
-
545
- Update low-balance notification settings.
546
-
547
- ### Example
548
-
549
- ```typescript
550
- import {
551
- BillingApi,
552
- Configuration,
553
- LowBalanceSettings
554
- } from '@pidginhost/sdk';
555
-
556
- const configuration = new Configuration();
557
- const apiInstance = new BillingApi(configuration);
558
-
559
- let lowBalanceSettings: LowBalanceSettings; //
560
-
561
- const { status, data } = await apiInstance.billingFundsNotificationSettingsCreate(
562
- lowBalanceSettings
563
- );
564
- ```
565
-
566
- ### Parameters
567
-
568
- |Name | Type | Description | Notes|
569
- |------------- | ------------- | ------------- | -------------|
570
- | **lowBalanceSettings** | **LowBalanceSettings**| | |
571
-
572
-
573
- ### Return type
574
-
575
- **NotificationSettingsResponse**
576
-
577
- ### Authorization
578
-
579
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
580
-
581
- ### HTTP request headers
582
-
583
- - **Content-Type**: application/json
584
- - **Accept**: application/json
585
-
586
-
587
- ### HTTP response details
588
- | Status code | Description | Response headers |
589
- |-------------|-------------|------------------|
590
- |**200** | | - |
591
-
592
- [[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)
593
-
594
- # **billingFundsNotificationSettingsCreate2**
595
- > NotificationSettingsResponse billingFundsNotificationSettingsCreate2(lowBalanceSettings)
596
-
597
- Update low-balance notification settings.
598
-
599
- ### Example
600
-
601
- ```typescript
602
- import {
603
- BillingApi,
604
- Configuration,
605
- LowBalanceSettings
606
- } from '@pidginhost/sdk';
607
-
608
- const configuration = new Configuration();
609
- const apiInstance = new BillingApi(configuration);
610
-
611
- let lowBalanceSettings: LowBalanceSettings; //
612
-
613
- const { status, data } = await apiInstance.billingFundsNotificationSettingsCreate2(
614
- lowBalanceSettings
615
- );
616
- ```
617
-
618
- ### Parameters
619
-
620
- |Name | Type | Description | Notes|
621
- |------------- | ------------- | ------------- | -------------|
622
- | **lowBalanceSettings** | **LowBalanceSettings**| | |
623
-
624
-
625
- ### Return type
626
-
627
- **NotificationSettingsResponse**
628
-
629
- ### Authorization
630
-
631
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
632
-
633
- ### HTTP request headers
634
-
635
- - **Content-Type**: application/json
636
- - **Accept**: application/json
637
-
638
-
639
- ### HTTP response details
640
- | Status code | Description | Response headers |
641
- |-------------|-------------|------------------|
642
- |**200** | | - |
643
-
644
- [[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)
645
-
646
- # **billingInvoicesList**
647
- > PaginatedInvoiceListList billingInvoicesList()
648
-
649
- List and retrieve invoices. Pay with funds or download PDF.
650
-
651
- ### Example
652
-
653
- ```typescript
654
- import {
655
- BillingApi,
656
- Configuration
657
- } from '@pidginhost/sdk';
658
-
659
- const configuration = new Configuration();
660
- const apiInstance = new BillingApi(configuration);
661
-
662
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
663
-
664
- const { status, data } = await apiInstance.billingInvoicesList(
665
- page
666
- );
667
- ```
668
-
669
- ### Parameters
670
-
671
- |Name | Type | Description | Notes|
672
- |------------- | ------------- | ------------- | -------------|
673
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
674
-
675
-
676
- ### Return type
677
-
678
- **PaginatedInvoiceListList**
679
-
680
- ### Authorization
681
-
682
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
683
-
684
- ### HTTP request headers
685
-
686
- - **Content-Type**: Not defined
687
- - **Accept**: application/json
688
-
689
-
690
- ### HTTP response details
691
- | Status code | Description | Response headers |
692
- |-------------|-------------|------------------|
693
- |**200** | | - |
694
-
695
- [[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)
696
-
697
- # **billingInvoicesList2**
698
- > PaginatedInvoiceListList billingInvoicesList2()
699
-
700
- List and retrieve invoices. Pay with funds or download PDF.
701
-
702
- ### Example
703
-
704
- ```typescript
705
- import {
706
- BillingApi,
707
- Configuration
708
- } from '@pidginhost/sdk';
709
-
710
- const configuration = new Configuration();
711
- const apiInstance = new BillingApi(configuration);
712
-
713
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
714
-
715
- const { status, data } = await apiInstance.billingInvoicesList2(
716
- page
717
- );
718
- ```
719
-
720
- ### Parameters
721
-
722
- |Name | Type | Description | Notes|
723
- |------------- | ------------- | ------------- | -------------|
724
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
725
-
726
-
727
- ### Return type
728
-
729
- **PaginatedInvoiceListList**
730
-
731
- ### Authorization
732
-
733
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
734
-
735
- ### HTTP request headers
736
-
737
- - **Content-Type**: Not defined
738
- - **Accept**: application/json
739
-
740
-
741
- ### HTTP response details
742
- | Status code | Description | Response headers |
743
- |-------------|-------------|------------------|
744
- |**200** | | - |
745
-
746
- [[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)
747
-
748
- # **billingInvoicesPayWithFundsCreate**
749
- > PayWithFundsResponse billingInvoicesPayWithFundsCreate()
750
-
751
- Pay an unpaid/overdue invoice using account funds.
752
-
753
- ### Example
754
-
755
- ```typescript
756
- import {
757
- BillingApi,
758
- Configuration
759
- } from '@pidginhost/sdk';
760
-
761
- const configuration = new Configuration();
762
- const apiInstance = new BillingApi(configuration);
763
-
764
- let id: string; // (default to undefined)
765
-
766
- const { status, data } = await apiInstance.billingInvoicesPayWithFundsCreate(
767
- id
768
- );
769
- ```
770
-
771
- ### Parameters
772
-
773
- |Name | Type | Description | Notes|
774
- |------------- | ------------- | ------------- | -------------|
775
- | **id** | [**string**] | | defaults to undefined|
776
-
777
-
778
- ### Return type
779
-
780
- **PayWithFundsResponse**
781
-
782
- ### Authorization
783
-
784
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
785
-
786
- ### HTTP request headers
787
-
788
- - **Content-Type**: Not defined
789
- - **Accept**: application/json
790
-
791
-
792
- ### HTTP response details
793
- | Status code | Description | Response headers |
794
- |-------------|-------------|------------------|
795
- |**200** | | - |
796
-
797
- [[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)
798
-
799
- # **billingInvoicesPayWithFundsCreate2**
800
- > PayWithFundsResponse billingInvoicesPayWithFundsCreate2()
801
-
802
- Pay an unpaid/overdue invoice using account funds.
803
-
804
- ### Example
805
-
806
- ```typescript
807
- import {
808
- BillingApi,
809
- Configuration
810
- } from '@pidginhost/sdk';
811
-
812
- const configuration = new Configuration();
813
- const apiInstance = new BillingApi(configuration);
814
-
815
- let id: string; // (default to undefined)
816
-
817
- const { status, data } = await apiInstance.billingInvoicesPayWithFundsCreate2(
818
- id
819
- );
820
- ```
821
-
822
- ### Parameters
823
-
824
- |Name | Type | Description | Notes|
825
- |------------- | ------------- | ------------- | -------------|
826
- | **id** | [**string**] | | defaults to undefined|
827
-
828
-
829
- ### Return type
830
-
831
- **PayWithFundsResponse**
832
-
833
- ### Authorization
834
-
835
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
836
-
837
- ### HTTP request headers
838
-
839
- - **Content-Type**: Not defined
840
- - **Accept**: application/json
841
-
842
-
843
- ### HTTP response details
844
- | Status code | Description | Response headers |
845
- |-------------|-------------|------------------|
846
- |**200** | | - |
847
-
848
- [[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)
849
-
850
- # **billingInvoicesPdfRetrieve**
851
- > File billingInvoicesPdfRetrieve()
852
-
853
- Download invoice PDF. Use ?type=proforma or ?type=fiscal.
854
-
855
- ### Example
856
-
857
- ```typescript
858
- import {
859
- BillingApi,
860
- Configuration
861
- } from '@pidginhost/sdk';
862
-
863
- const configuration = new Configuration();
864
- const apiInstance = new BillingApi(configuration);
865
-
866
- let id: string; // (default to undefined)
867
-
868
- const { status, data } = await apiInstance.billingInvoicesPdfRetrieve(
869
- id
870
- );
871
- ```
872
-
873
- ### Parameters
874
-
875
- |Name | Type | Description | Notes|
876
- |------------- | ------------- | ------------- | -------------|
877
- | **id** | [**string**] | | defaults to undefined|
878
-
879
-
880
- ### Return type
881
-
882
- **File**
883
-
884
- ### Authorization
885
-
886
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
887
-
888
- ### HTTP request headers
889
-
890
- - **Content-Type**: Not defined
891
- - **Accept**: application/json
892
-
893
-
894
- ### HTTP response details
895
- | Status code | Description | Response headers |
896
- |-------------|-------------|------------------|
897
- |**200** | | - |
898
-
899
- [[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)
900
-
901
- # **billingInvoicesPdfRetrieve2**
902
- > File billingInvoicesPdfRetrieve2()
903
-
904
- Download invoice PDF. Use ?type=proforma or ?type=fiscal.
905
-
906
- ### Example
907
-
908
- ```typescript
909
- import {
910
- BillingApi,
911
- Configuration
912
- } from '@pidginhost/sdk';
913
-
914
- const configuration = new Configuration();
915
- const apiInstance = new BillingApi(configuration);
916
-
917
- let id: string; // (default to undefined)
918
-
919
- const { status, data } = await apiInstance.billingInvoicesPdfRetrieve2(
920
- id
921
- );
922
- ```
923
-
924
- ### Parameters
925
-
926
- |Name | Type | Description | Notes|
927
- |------------- | ------------- | ------------- | -------------|
928
- | **id** | [**string**] | | defaults to undefined|
929
-
930
-
931
- ### Return type
932
-
933
- **File**
934
-
935
- ### Authorization
936
-
937
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
938
-
939
- ### HTTP request headers
940
-
941
- - **Content-Type**: Not defined
942
- - **Accept**: application/json
943
-
944
-
945
- ### HTTP response details
946
- | Status code | Description | Response headers |
947
- |-------------|-------------|------------------|
948
- |**200** | | - |
949
-
950
- [[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)
951
-
952
- # **billingInvoicesRetrieve**
953
- > InvoiceDetail billingInvoicesRetrieve()
954
-
955
- List and retrieve invoices. Pay with funds or download PDF.
956
-
957
- ### Example
958
-
959
- ```typescript
960
- import {
961
- BillingApi,
962
- Configuration
963
- } from '@pidginhost/sdk';
964
-
965
- const configuration = new Configuration();
966
- const apiInstance = new BillingApi(configuration);
967
-
968
- let id: string; // (default to undefined)
969
-
970
- const { status, data } = await apiInstance.billingInvoicesRetrieve(
971
- id
972
- );
973
- ```
974
-
975
- ### Parameters
976
-
977
- |Name | Type | Description | Notes|
978
- |------------- | ------------- | ------------- | -------------|
979
- | **id** | [**string**] | | defaults to undefined|
980
-
981
-
982
- ### Return type
983
-
984
- **InvoiceDetail**
985
-
986
- ### Authorization
987
-
988
- [cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
989
-
990
- ### HTTP request headers
991
-
992
- - **Content-Type**: Not defined
993
- - **Accept**: application/json
994
-
995
-
996
- ### HTTP response details
997
- | Status code | Description | Response headers |
998
- |-------------|-------------|------------------|
999
- |**200** | | - |
1000
-
1001
- [[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)
1002
-
1003
- # **billingInvoicesRetrieve2**
1004
- > InvoiceDetail billingInvoicesRetrieve2()
79
+ > PaginatedDepositList billingDepositsList()
1005
80
 
1006
- List and retrieve invoices. Pay with funds or download PDF.
81
+ List, create, and retrieve fund deposits.
1007
82
 
1008
83
  ### Example
1009
84
 
@@ -1016,10 +91,10 @@ import {
1016
91
  const configuration = new Configuration();
1017
92
  const apiInstance = new BillingApi(configuration);
1018
93
 
1019
- let id: string; // (default to undefined)
94
+ let page: number; //A page number within the paginated result set. (optional) (default to undefined)
1020
95
 
1021
- const { status, data } = await apiInstance.billingInvoicesRetrieve2(
1022
- id
96
+ const { status, data } = await apiInstance.billingDepositsList(
97
+ page
1023
98
  );
1024
99
  ```
1025
100
 
@@ -1027,12 +102,12 @@ const { status, data } = await apiInstance.billingInvoicesRetrieve2(
1027
102
 
1028
103
  |Name | Type | Description | Notes|
1029
104
  |------------- | ------------- | ------------- | -------------|
1030
- | **id** | [**string**] | | defaults to undefined|
105
+ | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
1031
106
 
1032
107
 
1033
108
  ### Return type
1034
109
 
1035
- **InvoiceDetail**
110
+ **PaginatedDepositList**
1036
111
 
1037
112
  ### Authorization
1038
113
 
@@ -1051,10 +126,10 @@ const { status, data } = await apiInstance.billingInvoicesRetrieve2(
1051
126
 
1052
127
  [[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)
1053
128
 
1054
- # **billingServicesCancelCreate**
1055
- > CancelServiceResponse billingServicesCancelCreate()
129
+ # **billingDepositsRetrieve**
130
+ > Deposit billingDepositsRetrieve()
1056
131
 
1057
- Cancel a service. Pending services are cancelled immediately; active services are terminated.
132
+ List, create, and retrieve fund deposits.
1058
133
 
1059
134
  ### Example
1060
135
 
@@ -1069,7 +144,7 @@ const apiInstance = new BillingApi(configuration);
1069
144
 
1070
145
  let id: string; // (default to undefined)
1071
146
 
1072
- const { status, data } = await apiInstance.billingServicesCancelCreate(
147
+ const { status, data } = await apiInstance.billingDepositsRetrieve(
1073
148
  id
1074
149
  );
1075
150
  ```
@@ -1083,7 +158,7 @@ const { status, data } = await apiInstance.billingServicesCancelCreate(
1083
158
 
1084
159
  ### Return type
1085
160
 
1086
- **CancelServiceResponse**
161
+ **Deposit**
1087
162
 
1088
163
  ### Authorization
1089
164
 
@@ -1102,10 +177,10 @@ const { status, data } = await apiInstance.billingServicesCancelCreate(
1102
177
 
1103
178
  [[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)
1104
179
 
1105
- # **billingServicesCancelCreate2**
1106
- > CancelServiceResponse billingServicesCancelCreate2()
180
+ # **billingFundsList**
181
+ > Array<FundsBalanceResponse> billingFundsList()
1107
182
 
1108
- Cancel a service. Pending services are cancelled immediately; active services are terminated.
183
+ Get current funds balance and notification settings.
1109
184
 
1110
185
  ### Example
1111
186
 
@@ -1118,23 +193,16 @@ import {
1118
193
  const configuration = new Configuration();
1119
194
  const apiInstance = new BillingApi(configuration);
1120
195
 
1121
- let id: string; // (default to undefined)
1122
-
1123
- const { status, data } = await apiInstance.billingServicesCancelCreate2(
1124
- id
1125
- );
196
+ const { status, data } = await apiInstance.billingFundsList();
1126
197
  ```
1127
198
 
1128
199
  ### Parameters
1129
-
1130
- |Name | Type | Description | Notes|
1131
- |------------- | ------------- | ------------- | -------------|
1132
- | **id** | [**string**] | | defaults to undefined|
200
+ This endpoint does not have any parameters.
1133
201
 
1134
202
 
1135
203
  ### Return type
1136
204
 
1137
- **CancelServiceResponse**
205
+ **Array<FundsBalanceResponse>**
1138
206
 
1139
207
  ### Authorization
1140
208
 
@@ -1153,29 +221,26 @@ const { status, data } = await apiInstance.billingServicesCancelCreate2(
1153
221
 
1154
222
  [[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)
1155
223
 
1156
- # **billingServicesChangeBillingCycleCreate**
1157
- > ChangeBillingCycleResponse billingServicesChangeBillingCycleCreate(changeBillingCycle)
224
+ # **billingFundsLogList**
225
+ > PaginatedFundsLogList billingFundsLogList()
1158
226
 
1159
- Change the billing cycle of a service.
227
+ List funds log entries for the authenticated user.
1160
228
 
1161
229
  ### Example
1162
230
 
1163
231
  ```typescript
1164
232
  import {
1165
233
  BillingApi,
1166
- Configuration,
1167
- ChangeBillingCycle
234
+ Configuration
1168
235
  } from '@pidginhost/sdk';
1169
236
 
1170
237
  const configuration = new Configuration();
1171
238
  const apiInstance = new BillingApi(configuration);
1172
239
 
1173
- let id: string; // (default to undefined)
1174
- let changeBillingCycle: ChangeBillingCycle; //
240
+ let page: number; //A page number within the paginated result set. (optional) (default to undefined)
1175
241
 
1176
- const { status, data } = await apiInstance.billingServicesChangeBillingCycleCreate(
1177
- id,
1178
- changeBillingCycle
242
+ const { status, data } = await apiInstance.billingFundsLogList(
243
+ page
1179
244
  );
1180
245
  ```
1181
246
 
@@ -1183,13 +248,12 @@ const { status, data } = await apiInstance.billingServicesChangeBillingCycleCrea
1183
248
 
1184
249
  |Name | Type | Description | Notes|
1185
250
  |------------- | ------------- | ------------- | -------------|
1186
- | **changeBillingCycle** | **ChangeBillingCycle**| | |
1187
- | **id** | [**string**] | | defaults to undefined|
251
+ | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
1188
252
 
1189
253
 
1190
254
  ### Return type
1191
255
 
1192
- **ChangeBillingCycleResponse**
256
+ **PaginatedFundsLogList**
1193
257
 
1194
258
  ### Authorization
1195
259
 
@@ -1197,7 +261,7 @@ const { status, data } = await apiInstance.billingServicesChangeBillingCycleCrea
1197
261
 
1198
262
  ### HTTP request headers
1199
263
 
1200
- - **Content-Type**: application/json
264
+ - **Content-Type**: Not defined
1201
265
  - **Accept**: application/json
1202
266
 
1203
267
 
@@ -1208,10 +272,10 @@ const { status, data } = await apiInstance.billingServicesChangeBillingCycleCrea
1208
272
 
1209
273
  [[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)
1210
274
 
1211
- # **billingServicesChangeBillingCycleCreate2**
1212
- > ChangeBillingCycleResponse billingServicesChangeBillingCycleCreate2(changeBillingCycle)
275
+ # **billingFundsNotificationSettingsCreate**
276
+ > NotificationSettingsResponse billingFundsNotificationSettingsCreate(lowBalanceSettings)
1213
277
 
1214
- Change the billing cycle of a service.
278
+ Update low-balance notification settings.
1215
279
 
1216
280
  ### Example
1217
281
 
@@ -1219,18 +283,16 @@ Change the billing cycle of a service.
1219
283
  import {
1220
284
  BillingApi,
1221
285
  Configuration,
1222
- ChangeBillingCycle
286
+ LowBalanceSettings
1223
287
  } from '@pidginhost/sdk';
1224
288
 
1225
289
  const configuration = new Configuration();
1226
290
  const apiInstance = new BillingApi(configuration);
1227
291
 
1228
- let id: string; // (default to undefined)
1229
- let changeBillingCycle: ChangeBillingCycle; //
292
+ let lowBalanceSettings: LowBalanceSettings; //
1230
293
 
1231
- const { status, data } = await apiInstance.billingServicesChangeBillingCycleCreate2(
1232
- id,
1233
- changeBillingCycle
294
+ const { status, data } = await apiInstance.billingFundsNotificationSettingsCreate(
295
+ lowBalanceSettings
1234
296
  );
1235
297
  ```
1236
298
 
@@ -1238,13 +300,12 @@ const { status, data } = await apiInstance.billingServicesChangeBillingCycleCrea
1238
300
 
1239
301
  |Name | Type | Description | Notes|
1240
302
  |------------- | ------------- | ------------- | -------------|
1241
- | **changeBillingCycle** | **ChangeBillingCycle**| | |
1242
- | **id** | [**string**] | | defaults to undefined|
303
+ | **lowBalanceSettings** | **LowBalanceSettings**| | |
1243
304
 
1244
305
 
1245
306
  ### Return type
1246
307
 
1247
- **ChangeBillingCycleResponse**
308
+ **NotificationSettingsResponse**
1248
309
 
1249
310
  ### Authorization
1250
311
 
@@ -1263,29 +324,26 @@ const { status, data } = await apiInstance.billingServicesChangeBillingCycleCrea
1263
324
 
1264
325
  [[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)
1265
326
 
1266
- # **billingServicesChangeCompanyCreate**
1267
- > ChangeCompanyResponse billingServicesChangeCompanyCreate()
327
+ # **billingInvoicesList**
328
+ > PaginatedInvoiceListList billingInvoicesList()
1268
329
 
1269
- Change the company associated with a service.
330
+ List and retrieve invoices. Pay with funds or download PDF.
1270
331
 
1271
332
  ### Example
1272
333
 
1273
334
  ```typescript
1274
335
  import {
1275
336
  BillingApi,
1276
- Configuration,
1277
- ChangeCompany
337
+ Configuration
1278
338
  } from '@pidginhost/sdk';
1279
339
 
1280
340
  const configuration = new Configuration();
1281
341
  const apiInstance = new BillingApi(configuration);
1282
342
 
1283
- let id: string; // (default to undefined)
1284
- let changeCompany: ChangeCompany; // (optional)
343
+ let page: number; //A page number within the paginated result set. (optional) (default to undefined)
1285
344
 
1286
- const { status, data } = await apiInstance.billingServicesChangeCompanyCreate(
1287
- id,
1288
- changeCompany
345
+ const { status, data } = await apiInstance.billingInvoicesList(
346
+ page
1289
347
  );
1290
348
  ```
1291
349
 
@@ -1293,13 +351,12 @@ const { status, data } = await apiInstance.billingServicesChangeCompanyCreate(
1293
351
 
1294
352
  |Name | Type | Description | Notes|
1295
353
  |------------- | ------------- | ------------- | -------------|
1296
- | **changeCompany** | **ChangeCompany**| | |
1297
- | **id** | [**string**] | | defaults to undefined|
354
+ | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
1298
355
 
1299
356
 
1300
357
  ### Return type
1301
358
 
1302
- **ChangeCompanyResponse**
359
+ **PaginatedInvoiceListList**
1303
360
 
1304
361
  ### Authorization
1305
362
 
@@ -1307,7 +364,7 @@ const { status, data } = await apiInstance.billingServicesChangeCompanyCreate(
1307
364
 
1308
365
  ### HTTP request headers
1309
366
 
1310
- - **Content-Type**: application/json
367
+ - **Content-Type**: Not defined
1311
368
  - **Accept**: application/json
1312
369
 
1313
370
 
@@ -1318,29 +375,26 @@ const { status, data } = await apiInstance.billingServicesChangeCompanyCreate(
1318
375
 
1319
376
  [[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)
1320
377
 
1321
- # **billingServicesChangeCompanyCreate2**
1322
- > ChangeCompanyResponse billingServicesChangeCompanyCreate2()
378
+ # **billingInvoicesPayWithFundsCreate**
379
+ > PayWithFundsResponse billingInvoicesPayWithFundsCreate()
1323
380
 
1324
- Change the company associated with a service.
381
+ Pay an unpaid/overdue invoice using account funds.
1325
382
 
1326
383
  ### Example
1327
384
 
1328
385
  ```typescript
1329
386
  import {
1330
387
  BillingApi,
1331
- Configuration,
1332
- ChangeCompany
388
+ Configuration
1333
389
  } from '@pidginhost/sdk';
1334
390
 
1335
391
  const configuration = new Configuration();
1336
392
  const apiInstance = new BillingApi(configuration);
1337
393
 
1338
394
  let id: string; // (default to undefined)
1339
- let changeCompany: ChangeCompany; // (optional)
1340
395
 
1341
- const { status, data } = await apiInstance.billingServicesChangeCompanyCreate2(
1342
- id,
1343
- changeCompany
396
+ const { status, data } = await apiInstance.billingInvoicesPayWithFundsCreate(
397
+ id
1344
398
  );
1345
399
  ```
1346
400
 
@@ -1348,13 +402,12 @@ const { status, data } = await apiInstance.billingServicesChangeCompanyCreate2(
1348
402
 
1349
403
  |Name | Type | Description | Notes|
1350
404
  |------------- | ------------- | ------------- | -------------|
1351
- | **changeCompany** | **ChangeCompany**| | |
1352
405
  | **id** | [**string**] | | defaults to undefined|
1353
406
 
1354
407
 
1355
408
  ### Return type
1356
409
 
1357
- **ChangeCompanyResponse**
410
+ **PayWithFundsResponse**
1358
411
 
1359
412
  ### Authorization
1360
413
 
@@ -1362,7 +415,7 @@ const { status, data } = await apiInstance.billingServicesChangeCompanyCreate2(
1362
415
 
1363
416
  ### HTTP request headers
1364
417
 
1365
- - **Content-Type**: application/json
418
+ - **Content-Type**: Not defined
1366
419
  - **Accept**: application/json
1367
420
 
1368
421
 
@@ -1373,10 +426,10 @@ const { status, data } = await apiInstance.billingServicesChangeCompanyCreate2(
1373
426
 
1374
427
  [[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)
1375
428
 
1376
- # **billingServicesList**
1377
- > PaginatedServiceListList billingServicesList()
429
+ # **billingInvoicesPdfRetrieve**
430
+ > File billingInvoicesPdfRetrieve()
1378
431
 
1379
- List and manage billing services.
432
+ Download invoice PDF. Use ?type=proforma or ?type=fiscal.
1380
433
 
1381
434
  ### Example
1382
435
 
@@ -1389,10 +442,10 @@ import {
1389
442
  const configuration = new Configuration();
1390
443
  const apiInstance = new BillingApi(configuration);
1391
444
 
1392
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
445
+ let id: string; // (default to undefined)
1393
446
 
1394
- const { status, data } = await apiInstance.billingServicesList(
1395
- page
447
+ const { status, data } = await apiInstance.billingInvoicesPdfRetrieve(
448
+ id
1396
449
  );
1397
450
  ```
1398
451
 
@@ -1400,12 +453,12 @@ const { status, data } = await apiInstance.billingServicesList(
1400
453
 
1401
454
  |Name | Type | Description | Notes|
1402
455
  |------------- | ------------- | ------------- | -------------|
1403
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
456
+ | **id** | [**string**] | | defaults to undefined|
1404
457
 
1405
458
 
1406
459
  ### Return type
1407
460
 
1408
- **PaginatedServiceListList**
461
+ **File**
1409
462
 
1410
463
  ### Authorization
1411
464
 
@@ -1424,10 +477,10 @@ const { status, data } = await apiInstance.billingServicesList(
1424
477
 
1425
478
  [[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)
1426
479
 
1427
- # **billingServicesList2**
1428
- > PaginatedServiceListList billingServicesList2()
480
+ # **billingInvoicesRetrieve**
481
+ > InvoiceDetail billingInvoicesRetrieve()
1429
482
 
1430
- List and manage billing services.
483
+ List and retrieve invoices. Pay with funds or download PDF.
1431
484
 
1432
485
  ### Example
1433
486
 
@@ -1440,10 +493,10 @@ import {
1440
493
  const configuration = new Configuration();
1441
494
  const apiInstance = new BillingApi(configuration);
1442
495
 
1443
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
496
+ let id: string; // (default to undefined)
1444
497
 
1445
- const { status, data } = await apiInstance.billingServicesList2(
1446
- page
498
+ const { status, data } = await apiInstance.billingInvoicesRetrieve(
499
+ id
1447
500
  );
1448
501
  ```
1449
502
 
@@ -1451,12 +504,12 @@ const { status, data } = await apiInstance.billingServicesList2(
1451
504
 
1452
505
  |Name | Type | Description | Notes|
1453
506
  |------------- | ------------- | ------------- | -------------|
1454
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
507
+ | **id** | [**string**] | | defaults to undefined|
1455
508
 
1456
509
 
1457
510
  ### Return type
1458
511
 
1459
- **PaginatedServiceListList**
512
+ **InvoiceDetail**
1460
513
 
1461
514
  ### Authorization
1462
515
 
@@ -1475,10 +528,10 @@ const { status, data } = await apiInstance.billingServicesList2(
1475
528
 
1476
529
  [[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)
1477
530
 
1478
- # **billingServicesRetrieve**
1479
- > ServiceList billingServicesRetrieve()
531
+ # **billingServicesCancelCreate**
532
+ > CancelServiceResponse billingServicesCancelCreate()
1480
533
 
1481
- List and manage billing services.
534
+ Cancel a service. Pending services are cancelled immediately; active services are terminated.
1482
535
 
1483
536
  ### Example
1484
537
 
@@ -1493,7 +546,7 @@ const apiInstance = new BillingApi(configuration);
1493
546
 
1494
547
  let id: string; // (default to undefined)
1495
548
 
1496
- const { status, data } = await apiInstance.billingServicesRetrieve(
549
+ const { status, data } = await apiInstance.billingServicesCancelCreate(
1497
550
  id
1498
551
  );
1499
552
  ```
@@ -1507,7 +560,7 @@ const { status, data } = await apiInstance.billingServicesRetrieve(
1507
560
 
1508
561
  ### Return type
1509
562
 
1510
- **ServiceList**
563
+ **CancelServiceResponse**
1511
564
 
1512
565
  ### Authorization
1513
566
 
@@ -1526,26 +579,29 @@ const { status, data } = await apiInstance.billingServicesRetrieve(
1526
579
 
1527
580
  [[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)
1528
581
 
1529
- # **billingServicesRetrieve2**
1530
- > ServiceList billingServicesRetrieve2()
582
+ # **billingServicesChangeBillingCycleCreate**
583
+ > ChangeBillingCycleResponse billingServicesChangeBillingCycleCreate(changeBillingCycle)
1531
584
 
1532
- List and manage billing services.
585
+ Change the billing cycle of a service.
1533
586
 
1534
587
  ### Example
1535
588
 
1536
589
  ```typescript
1537
590
  import {
1538
591
  BillingApi,
1539
- Configuration
592
+ Configuration,
593
+ ChangeBillingCycle
1540
594
  } from '@pidginhost/sdk';
1541
595
 
1542
596
  const configuration = new Configuration();
1543
597
  const apiInstance = new BillingApi(configuration);
1544
598
 
1545
599
  let id: string; // (default to undefined)
600
+ let changeBillingCycle: ChangeBillingCycle; //
1546
601
 
1547
- const { status, data } = await apiInstance.billingServicesRetrieve2(
1548
- id
602
+ const { status, data } = await apiInstance.billingServicesChangeBillingCycleCreate(
603
+ id,
604
+ changeBillingCycle
1549
605
  );
1550
606
  ```
1551
607
 
@@ -1553,12 +609,13 @@ const { status, data } = await apiInstance.billingServicesRetrieve2(
1553
609
 
1554
610
  |Name | Type | Description | Notes|
1555
611
  |------------- | ------------- | ------------- | -------------|
612
+ | **changeBillingCycle** | **ChangeBillingCycle**| | |
1556
613
  | **id** | [**string**] | | defaults to undefined|
1557
614
 
1558
615
 
1559
616
  ### Return type
1560
617
 
1561
- **ServiceList**
618
+ **ChangeBillingCycleResponse**
1562
619
 
1563
620
  ### Authorization
1564
621
 
@@ -1566,7 +623,7 @@ const { status, data } = await apiInstance.billingServicesRetrieve2(
1566
623
 
1567
624
  ### HTTP request headers
1568
625
 
1569
- - **Content-Type**: Not defined
626
+ - **Content-Type**: application/json
1570
627
  - **Accept**: application/json
1571
628
 
1572
629
 
@@ -1577,26 +634,29 @@ const { status, data } = await apiInstance.billingServicesRetrieve2(
1577
634
 
1578
635
  [[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)
1579
636
 
1580
- # **billingServicesToggleAutoPaymentCreate**
1581
- > ToggleAutoPaymentResponse billingServicesToggleAutoPaymentCreate()
637
+ # **billingServicesChangeCompanyCreate**
638
+ > ChangeCompanyResponse billingServicesChangeCompanyCreate()
1582
639
 
1583
- Toggle automatic payment for a service.
640
+ Change the company associated with a service.
1584
641
 
1585
642
  ### Example
1586
643
 
1587
644
  ```typescript
1588
645
  import {
1589
646
  BillingApi,
1590
- Configuration
647
+ Configuration,
648
+ ChangeCompany
1591
649
  } from '@pidginhost/sdk';
1592
650
 
1593
651
  const configuration = new Configuration();
1594
652
  const apiInstance = new BillingApi(configuration);
1595
653
 
1596
654
  let id: string; // (default to undefined)
655
+ let changeCompany: ChangeCompany; // (optional)
1597
656
 
1598
- const { status, data } = await apiInstance.billingServicesToggleAutoPaymentCreate(
1599
- id
657
+ const { status, data } = await apiInstance.billingServicesChangeCompanyCreate(
658
+ id,
659
+ changeCompany
1600
660
  );
1601
661
  ```
1602
662
 
@@ -1604,12 +664,13 @@ const { status, data } = await apiInstance.billingServicesToggleAutoPaymentCreat
1604
664
 
1605
665
  |Name | Type | Description | Notes|
1606
666
  |------------- | ------------- | ------------- | -------------|
667
+ | **changeCompany** | **ChangeCompany**| | |
1607
668
  | **id** | [**string**] | | defaults to undefined|
1608
669
 
1609
670
 
1610
671
  ### Return type
1611
672
 
1612
- **ToggleAutoPaymentResponse**
673
+ **ChangeCompanyResponse**
1613
674
 
1614
675
  ### Authorization
1615
676
 
@@ -1617,7 +678,7 @@ const { status, data } = await apiInstance.billingServicesToggleAutoPaymentCreat
1617
678
 
1618
679
  ### HTTP request headers
1619
680
 
1620
- - **Content-Type**: Not defined
681
+ - **Content-Type**: application/json
1621
682
  - **Accept**: application/json
1622
683
 
1623
684
 
@@ -1628,10 +689,10 @@ const { status, data } = await apiInstance.billingServicesToggleAutoPaymentCreat
1628
689
 
1629
690
  [[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)
1630
691
 
1631
- # **billingServicesToggleAutoPaymentCreate2**
1632
- > ToggleAutoPaymentResponse billingServicesToggleAutoPaymentCreate2()
692
+ # **billingServicesList**
693
+ > PaginatedServiceListList billingServicesList()
1633
694
 
1634
- Toggle automatic payment for a service.
695
+ List and manage billing services.
1635
696
 
1636
697
  ### Example
1637
698
 
@@ -1644,10 +705,10 @@ import {
1644
705
  const configuration = new Configuration();
1645
706
  const apiInstance = new BillingApi(configuration);
1646
707
 
1647
- let id: string; // (default to undefined)
708
+ let page: number; //A page number within the paginated result set. (optional) (default to undefined)
1648
709
 
1649
- const { status, data } = await apiInstance.billingServicesToggleAutoPaymentCreate2(
1650
- id
710
+ const { status, data } = await apiInstance.billingServicesList(
711
+ page
1651
712
  );
1652
713
  ```
1653
714
 
@@ -1655,12 +716,12 @@ const { status, data } = await apiInstance.billingServicesToggleAutoPaymentCreat
1655
716
 
1656
717
  |Name | Type | Description | Notes|
1657
718
  |------------- | ------------- | ------------- | -------------|
1658
- | **id** | [**string**] | | defaults to undefined|
719
+ | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
1659
720
 
1660
721
 
1661
722
  ### Return type
1662
723
 
1663
- **ToggleAutoPaymentResponse**
724
+ **PaginatedServiceListList**
1664
725
 
1665
726
  ### Authorization
1666
727
 
@@ -1679,10 +740,10 @@ const { status, data } = await apiInstance.billingServicesToggleAutoPaymentCreat
1679
740
 
1680
741
  [[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)
1681
742
 
1682
- # **billingSubscriptionsList**
1683
- > PaginatedSubscriptionList billingSubscriptionsList()
743
+ # **billingServicesRetrieve**
744
+ > ServiceList billingServicesRetrieve()
1684
745
 
1685
- List and retrieve subscriptions.
746
+ List and manage billing services.
1686
747
 
1687
748
  ### Example
1688
749
 
@@ -1695,10 +756,10 @@ import {
1695
756
  const configuration = new Configuration();
1696
757
  const apiInstance = new BillingApi(configuration);
1697
758
 
1698
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
759
+ let id: string; // (default to undefined)
1699
760
 
1700
- const { status, data } = await apiInstance.billingSubscriptionsList(
1701
- page
761
+ const { status, data } = await apiInstance.billingServicesRetrieve(
762
+ id
1702
763
  );
1703
764
  ```
1704
765
 
@@ -1706,12 +767,12 @@ const { status, data } = await apiInstance.billingSubscriptionsList(
1706
767
 
1707
768
  |Name | Type | Description | Notes|
1708
769
  |------------- | ------------- | ------------- | -------------|
1709
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
770
+ | **id** | [**string**] | | defaults to undefined|
1710
771
 
1711
772
 
1712
773
  ### Return type
1713
774
 
1714
- **PaginatedSubscriptionList**
775
+ **ServiceList**
1715
776
 
1716
777
  ### Authorization
1717
778
 
@@ -1730,10 +791,10 @@ const { status, data } = await apiInstance.billingSubscriptionsList(
1730
791
 
1731
792
  [[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)
1732
793
 
1733
- # **billingSubscriptionsList2**
1734
- > PaginatedSubscriptionList billingSubscriptionsList2()
794
+ # **billingServicesToggleAutoPaymentCreate**
795
+ > ToggleAutoPaymentResponse billingServicesToggleAutoPaymentCreate()
1735
796
 
1736
- List and retrieve subscriptions.
797
+ Toggle automatic payment for a service.
1737
798
 
1738
799
  ### Example
1739
800
 
@@ -1746,10 +807,10 @@ import {
1746
807
  const configuration = new Configuration();
1747
808
  const apiInstance = new BillingApi(configuration);
1748
809
 
1749
- let page: number; //A page number within the paginated result set. (optional) (default to undefined)
810
+ let id: string; // (default to undefined)
1750
811
 
1751
- const { status, data } = await apiInstance.billingSubscriptionsList2(
1752
- page
812
+ const { status, data } = await apiInstance.billingServicesToggleAutoPaymentCreate(
813
+ id
1753
814
  );
1754
815
  ```
1755
816
 
@@ -1757,12 +818,12 @@ const { status, data } = await apiInstance.billingSubscriptionsList2(
1757
818
 
1758
819
  |Name | Type | Description | Notes|
1759
820
  |------------- | ------------- | ------------- | -------------|
1760
- | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
821
+ | **id** | [**string**] | | defaults to undefined|
1761
822
 
1762
823
 
1763
824
  ### Return type
1764
825
 
1765
- **PaginatedSubscriptionList**
826
+ **ToggleAutoPaymentResponse**
1766
827
 
1767
828
  ### Authorization
1768
829
 
@@ -1781,8 +842,8 @@ const { status, data } = await apiInstance.billingSubscriptionsList2(
1781
842
 
1782
843
  [[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)
1783
844
 
1784
- # **billingSubscriptionsRetrieve**
1785
- > Subscription billingSubscriptionsRetrieve()
845
+ # **billingSubscriptionsList**
846
+ > PaginatedSubscriptionList billingSubscriptionsList()
1786
847
 
1787
848
  List and retrieve subscriptions.
1788
849
 
@@ -1797,10 +858,10 @@ import {
1797
858
  const configuration = new Configuration();
1798
859
  const apiInstance = new BillingApi(configuration);
1799
860
 
1800
- let id: string; // (default to undefined)
861
+ let page: number; //A page number within the paginated result set. (optional) (default to undefined)
1801
862
 
1802
- const { status, data } = await apiInstance.billingSubscriptionsRetrieve(
1803
- id
863
+ const { status, data } = await apiInstance.billingSubscriptionsList(
864
+ page
1804
865
  );
1805
866
  ```
1806
867
 
@@ -1808,12 +869,12 @@ const { status, data } = await apiInstance.billingSubscriptionsRetrieve(
1808
869
 
1809
870
  |Name | Type | Description | Notes|
1810
871
  |------------- | ------------- | ------------- | -------------|
1811
- | **id** | [**string**] | | defaults to undefined|
872
+ | **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
1812
873
 
1813
874
 
1814
875
  ### Return type
1815
876
 
1816
- **Subscription**
877
+ **PaginatedSubscriptionList**
1817
878
 
1818
879
  ### Authorization
1819
880
 
@@ -1832,8 +893,8 @@ const { status, data } = await apiInstance.billingSubscriptionsRetrieve(
1832
893
 
1833
894
  [[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)
1834
895
 
1835
- # **billingSubscriptionsRetrieve2**
1836
- > Subscription billingSubscriptionsRetrieve2()
896
+ # **billingSubscriptionsRetrieve**
897
+ > Subscription billingSubscriptionsRetrieve()
1837
898
 
1838
899
  List and retrieve subscriptions.
1839
900
 
@@ -1850,7 +911,7 @@ const apiInstance = new BillingApi(configuration);
1850
911
 
1851
912
  let id: string; // (default to undefined)
1852
913
 
1853
- const { status, data } = await apiInstance.billingSubscriptionsRetrieve2(
914
+ const { status, data } = await apiInstance.billingSubscriptionsRetrieve(
1854
915
  id
1855
916
  );
1856
917
  ```