yellowgrid-api-ts 3.2.154-dev.0 → 3.2.154

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.
Files changed (98) hide show
  1. package/.openapi-generator/FILES +291 -269
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +52 -3
  4. package/api.ts +3047 -5202
  5. package/base.ts +2 -26
  6. package/common.ts +16 -39
  7. package/config.json +3 -3
  8. package/configuration.ts +27 -21
  9. package/dist/api.d.ts +1419 -4518
  10. package/dist/api.js +3142 -961
  11. package/dist/base.d.ts +1 -25
  12. package/dist/base.js +2 -21
  13. package/dist/common.d.ts +5 -36
  14. package/dist/common.js +17 -39
  15. package/dist/configuration.d.ts +25 -18
  16. package/dist/configuration.js +4 -4
  17. package/dist/index.d.ts +1 -1
  18. package/dist/index.js +1 -1
  19. package/dist/models/HostingPriceListEnum.d.ts +28 -0
  20. package/dist/models/HostingPriceListEnum.js +30 -0
  21. package/dist/models/UserGroupEnum.d.ts +5 -0
  22. package/dist/models/UserGroupEnum.js +5 -0
  23. package/docs/AbstractOrderRequestDTO.md +1 -1
  24. package/docs/AccountAddressesDTO.md +25 -0
  25. package/docs/AccountFinanceDTO.md +37 -0
  26. package/docs/AccountsApi.md +1380 -54
  27. package/docs/AddressDTO.md +31 -0
  28. package/docs/AdminOrderRequestDTO.md +1 -1
  29. package/docs/AdminUserModel.md +2 -0
  30. package/docs/BillingApi.md +55 -0
  31. package/docs/CRMApi.md +121 -1
  32. package/docs/Class3CXApi.md +49 -1
  33. package/docs/Class3CXInstallationWizardApi.md +1 -1
  34. package/docs/Class3CXInstallationsApi.md +56 -1
  35. package/docs/Class3CXIntegrationsApi.md +1 -1
  36. package/docs/Class3CXMultiTenantApi.md +1 -1
  37. package/docs/{PostAddAdminNoteRequest.md → CreateCrmNoteBody.md} +3 -3
  38. package/docs/CreditAccountEntity.md +4 -0
  39. package/docs/CrmActivitiesResponseDTO.md +23 -0
  40. package/docs/CrmActivityDTO.md +33 -0
  41. package/docs/CrmDateActivitiesDTO.md +23 -0
  42. package/docs/CrmNoteEntity.md +39 -0
  43. package/docs/CrmNoteModel.md +39 -0
  44. package/docs/CustomerOrderRequestDTO.md +1 -1
  45. package/docs/DetailedOrderRequestDTO.md +1 -1
  46. package/docs/MyPBXToolsApi.md +1 -1
  47. package/docs/NumberPortAdminNoteBody.md +20 -0
  48. package/docs/NumberPortingApi.md +6 -6
  49. package/docs/OAuth20Api.md +49 -1
  50. package/docs/OrdersApi.md +1 -1
  51. package/docs/PartnerDTO.md +39 -0
  52. package/docs/{PatchSetTcxWizardCnameRequest.md → PatchUpdateAccountCnameRequest.md} +3 -3
  53. package/docs/PatchUpdateAccountCompanyNumberRequest.md +20 -0
  54. package/docs/PatchUpdateAccountPhoneRequest.md +20 -0
  55. package/docs/PatchUpdateAccountVatNumberRequest.md +20 -0
  56. package/docs/PatchUpdateCreditLimitRequest.md +20 -0
  57. package/docs/PatchUpdatePriceListRequest.md +20 -0
  58. package/docs/PatchUpdateSipChannelCostRequest.md +20 -0
  59. package/docs/PatchUpdateTcxHostingPriceListRequest.md +20 -0
  60. package/docs/PatchUpdateTcxPartnerIdRequest.md +20 -0
  61. package/docs/PortalAccountModel.md +4 -2
  62. package/docs/PostSendWelcomeEmailRequest.md +20 -0
  63. package/docs/PricingApi.md +1 -1
  64. package/docs/ProductSummaryDTO.md +2 -2
  65. package/docs/ProductsApi.md +1 -1
  66. package/docs/ProspectDTO.md +4 -2
  67. package/docs/ProspectsApi.md +1 -1
  68. package/docs/ProvisioningApi.md +1 -1
  69. package/docs/RecordingBackupAzureModel.md +2 -0
  70. package/docs/RecordingsBackupInfoDTO.md +2 -2
  71. package/docs/SIPTrunksApi.md +1 -1
  72. package/docs/SMSApi.md +1 -1
  73. package/docs/ServicesApi.md +1 -1
  74. package/docs/ShipmentRequestDTO.md +2 -2
  75. package/docs/ShippingApi.md +1 -1
  76. package/docs/StockManagementApi.md +1 -1
  77. package/docs/SystemApi.md +1 -1
  78. package/docs/TableHistoryEntity.md +35 -0
  79. package/docs/TcxKeySummaryDTO.md +1 -1
  80. package/docs/TicketsApi.md +1 -1
  81. package/docs/WebhooksApi.md +1 -1
  82. package/getEnums.php +31 -31
  83. package/index.ts +1 -1
  84. package/models/HostingPriceListEnum.ts +29 -0
  85. package/models/UserGroupEnum.ts +5 -0
  86. package/openapitools.json +1 -1
  87. package/package.json +2 -2
  88. package/dist/models/GroupEnum.d.ts +0 -43
  89. package/dist/models/GroupEnum.js +0 -45
  90. package/docs/NumberPortModel.md +0 -51
  91. package/docs/PostGetProductRequest.md +0 -24
  92. package/docs/TcxInstallationDetailsModel.md +0 -45
  93. package/docs/TelephonySupportTicketModel.md +0 -41
  94. package/hs_err_pid16044.log +0 -249
  95. package/hs_err_pid44560.log +0 -249
  96. package/hs_err_pid53988.log +0 -249
  97. package/hs_err_pid58728.log +0 -40
  98. package/models/GroupEnum.ts +0 -44
@@ -1,28 +1,162 @@
1
1
  # AccountsApi
2
2
 
3
- All URIs are relative to *https://api.local.yellowgrid.co.uk*
3
+ All URIs are relative to *https://bitbucket.org*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**deleteAdminUpdateAccountContact**](#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} | |
8
+ |[**deleteArchiveAccount**](#deletearchiveaccount) | **DELETE** /admin/accounts/{id}/archive | |
7
9
  |[**deleteDeleteClientCredentials**](#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials|
8
10
  |[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
11
+ |[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | |
9
12
  |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
13
+ |[**getGetAccountAddresses**](#getgetaccountaddresses) | **GET** /admin/accounts/{id}/addresses | |
10
14
  |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
11
15
  |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
12
16
  |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
13
17
  |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
14
18
  |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
19
+ |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
20
+ |[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
21
+ |[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
15
22
  |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
23
+ |[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
24
+ |[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
16
25
  |[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
26
+ |[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
27
+ |[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
17
28
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
29
+ |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
30
+ |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
31
+ |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
32
+ |[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
33
+ |[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
34
+ |[**patchUpdateTcxHostingPriceList**](#patchupdatetcxhostingpricelist) | **PATCH** /admin/accounts/{id}/tcx/hosting/priceList | |
35
+ |[**patchUpdateTcxPartnerId**](#patchupdatetcxpartnerid) | **PATCH** /admin/accounts{id}/tcx/partner/id | |
36
+ |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
18
37
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
19
38
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
20
39
  |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
21
40
  |[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
22
41
  |[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
23
42
  |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
43
+ |[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
24
44
  |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
45
+ |[**putAdminUpdateAccountContact**](#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
25
46
  |[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
47
+ |[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
48
+ |[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
49
+
50
+ # **deleteAdminUpdateAccountContact**
51
+ > deleteAdminUpdateAccountContact()
52
+
53
+ Delete Account Contact
54
+
55
+ ### Example
56
+
57
+ ```typescript
58
+ import {
59
+ AccountsApi,
60
+ Configuration
61
+ } from 'yellowgrid-api-ts';
62
+
63
+ const configuration = new Configuration();
64
+ const apiInstance = new AccountsApi(configuration);
65
+
66
+ let id: string; //Account Xero ID (default to undefined)
67
+ let contactId: number; //Contact ID (default to undefined)
68
+
69
+ const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
70
+ id,
71
+ contactId
72
+ );
73
+ ```
74
+
75
+ ### Parameters
76
+
77
+ |Name | Type | Description | Notes|
78
+ |------------- | ------------- | ------------- | -------------|
79
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
80
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
81
+
82
+
83
+ ### Return type
84
+
85
+ void (empty response body)
86
+
87
+ ### Authorization
88
+
89
+ No authorization required
90
+
91
+ ### HTTP request headers
92
+
93
+ - **Content-Type**: Not defined
94
+ - **Accept**: Not defined
95
+
96
+
97
+ ### HTTP response details
98
+ | Status code | Description | Response headers |
99
+ |-------------|-------------|------------------|
100
+ |**204** | No Response | - |
101
+ |**400** | Bad Request | - |
102
+ |**401** | Unauthorised | - |
103
+ |**403** | Access Denied | - |
104
+
105
+ [[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)
106
+
107
+ # **deleteArchiveAccount**
108
+ > deleteArchiveAccount()
109
+
110
+ Delete Account
111
+
112
+ ### Example
113
+
114
+ ```typescript
115
+ import {
116
+ AccountsApi,
117
+ Configuration
118
+ } from 'yellowgrid-api-ts';
119
+
120
+ const configuration = new Configuration();
121
+ const apiInstance = new AccountsApi(configuration);
122
+
123
+ let id: string; //Account Xero ID (default to undefined)
124
+
125
+ const { status, data } = await apiInstance.deleteArchiveAccount(
126
+ id
127
+ );
128
+ ```
129
+
130
+ ### Parameters
131
+
132
+ |Name | Type | Description | Notes|
133
+ |------------- | ------------- | ------------- | -------------|
134
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
135
+
136
+
137
+ ### Return type
138
+
139
+ void (empty response body)
140
+
141
+ ### Authorization
142
+
143
+ No authorization required
144
+
145
+ ### HTTP request headers
146
+
147
+ - **Content-Type**: Not defined
148
+ - **Accept**: Not defined
149
+
150
+
151
+ ### HTTP response details
152
+ | Status code | Description | Response headers |
153
+ |-------------|-------------|------------------|
154
+ |**204** | No Response | - |
155
+ |**400** | Bad Request | - |
156
+ |**401** | Unauthorised | - |
157
+ |**403** | Access Denied | - |
158
+
159
+ [[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)
26
160
 
27
161
  # **deleteDeleteClientCredentials**
28
162
  > deleteDeleteClientCredentials()
@@ -132,6 +266,60 @@ No authorization required
132
266
 
133
267
  [[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)
134
268
 
269
+ # **getAdminCreateAccountContact**
270
+ > Array<AccountContactModel> getAdminCreateAccountContact()
271
+
272
+ Get Account Contacts
273
+
274
+ ### Example
275
+
276
+ ```typescript
277
+ import {
278
+ AccountsApi,
279
+ Configuration
280
+ } from 'yellowgrid-api-ts';
281
+
282
+ const configuration = new Configuration();
283
+ const apiInstance = new AccountsApi(configuration);
284
+
285
+ let id: string; //Account Xero ID (default to undefined)
286
+
287
+ const { status, data } = await apiInstance.getAdminCreateAccountContact(
288
+ id
289
+ );
290
+ ```
291
+
292
+ ### Parameters
293
+
294
+ |Name | Type | Description | Notes|
295
+ |------------- | ------------- | ------------- | -------------|
296
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
297
+
298
+
299
+ ### Return type
300
+
301
+ **Array<AccountContactModel>**
302
+
303
+ ### Authorization
304
+
305
+ No authorization required
306
+
307
+ ### HTTP request headers
308
+
309
+ - **Content-Type**: Not defined
310
+ - **Accept**: application/json
311
+
312
+
313
+ ### HTTP response details
314
+ | Status code | Description | Response headers |
315
+ |-------------|-------------|------------------|
316
+ |**200** | Account | - |
317
+ |**400** | Bad Request | - |
318
+ |**401** | Unauthorised | - |
319
+ |**403** | Access Denied | - |
320
+
321
+ [[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)
322
+
135
323
  # **getGetAccount**
136
324
  > PortalAccountModel getGetAccount()
137
325
 
@@ -179,6 +367,60 @@ No authorization required
179
367
 
180
368
  [[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)
181
369
 
370
+ # **getGetAccountAddresses**
371
+ > AccountAddressesDTO getGetAccountAddresses()
372
+
373
+ Get Account Addresses
374
+
375
+ ### Example
376
+
377
+ ```typescript
378
+ import {
379
+ AccountsApi,
380
+ Configuration
381
+ } from 'yellowgrid-api-ts';
382
+
383
+ const configuration = new Configuration();
384
+ const apiInstance = new AccountsApi(configuration);
385
+
386
+ let id: string; //Xero ID (default to undefined)
387
+
388
+ const { status, data } = await apiInstance.getGetAccountAddresses(
389
+ id
390
+ );
391
+ ```
392
+
393
+ ### Parameters
394
+
395
+ |Name | Type | Description | Notes|
396
+ |------------- | ------------- | ------------- | -------------|
397
+ | **id** | [**string**] | Xero ID | defaults to undefined|
398
+
399
+
400
+ ### Return type
401
+
402
+ **AccountAddressesDTO**
403
+
404
+ ### Authorization
405
+
406
+ No authorization required
407
+
408
+ ### HTTP request headers
409
+
410
+ - **Content-Type**: Not defined
411
+ - **Accept**: application/json
412
+
413
+
414
+ ### HTTP response details
415
+ | Status code | Description | Response headers |
416
+ |-------------|-------------|------------------|
417
+ |**200** | Account Addresses | - |
418
+ |**400** | Bad Request | - |
419
+ |**401** | Unauthorised | - |
420
+ |**403** | Access Denied | - |
421
+
422
+ [[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)
423
+
182
424
  # **getGetAccountContacts**
183
425
  > Array<AccountContactModel> getGetAccountContacts()
184
426
 
@@ -350,32 +592,863 @@ No authorization required
350
592
 
351
593
  [[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)
352
594
 
353
- # **getGetClientCredentials**
354
- > Array<ClientModel> getGetClientCredentials()
595
+ # **getGetClientCredentials**
596
+ > Array<ClientModel> getGetClientCredentials()
597
+
598
+ Get user\'s client credentials
599
+
600
+ ### Example
601
+
602
+ ```typescript
603
+ import {
604
+ AccountsApi,
605
+ Configuration
606
+ } from 'yellowgrid-api-ts';
607
+
608
+ const configuration = new Configuration();
609
+ const apiInstance = new AccountsApi(configuration);
610
+
611
+ const { status, data } = await apiInstance.getGetClientCredentials();
612
+ ```
613
+
614
+ ### Parameters
615
+ This endpoint does not have any parameters.
616
+
617
+
618
+ ### Return type
619
+
620
+ **Array<ClientModel>**
621
+
622
+ ### Authorization
623
+
624
+ No authorization required
625
+
626
+ ### HTTP request headers
627
+
628
+ - **Content-Type**: Not defined
629
+ - **Accept**: application/json
630
+
631
+
632
+ ### HTTP response details
633
+ | Status code | Description | Response headers |
634
+ |-------------|-------------|------------------|
635
+ |**200** | List of client credentials | - |
636
+ |**400** | Bad Request | - |
637
+ |**401** | Unauthorised | - |
638
+ |**403** | Access Denied | - |
639
+
640
+ [[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)
641
+
642
+ # **getGetCustomerKeys**
643
+ > Array<TcxKeySummaryDTO> getGetCustomerKeys()
644
+
645
+ Get 3CX Keys
646
+
647
+ ### Example
648
+
649
+ ```typescript
650
+ import {
651
+ AccountsApi,
652
+ Configuration
653
+ } from 'yellowgrid-api-ts';
654
+
655
+ const configuration = new Configuration();
656
+ const apiInstance = new AccountsApi(configuration);
657
+
658
+ const { status, data } = await apiInstance.getGetCustomerKeys();
659
+ ```
660
+
661
+ ### Parameters
662
+ This endpoint does not have any parameters.
663
+
664
+
665
+ ### Return type
666
+
667
+ **Array<TcxKeySummaryDTO>**
668
+
669
+ ### Authorization
670
+
671
+ No authorization required
672
+
673
+ ### HTTP request headers
674
+
675
+ - **Content-Type**: Not defined
676
+ - **Accept**: application/json
677
+
678
+
679
+ ### HTTP response details
680
+ | Status code | Description | Response headers |
681
+ |-------------|-------------|------------------|
682
+ |**200** | 3CX Key Summaries | - |
683
+ |**400** | Bad Request | - |
684
+ |**401** | Unauthorised | - |
685
+ |**403** | Access Denied | - |
686
+
687
+ [[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)
688
+
689
+ # **getGetFinanceSettings**
690
+ > AccountFinanceDTO getGetFinanceSettings()
691
+
692
+ Get Account Finance
693
+
694
+ ### Example
695
+
696
+ ```typescript
697
+ import {
698
+ AccountsApi,
699
+ Configuration
700
+ } from 'yellowgrid-api-ts';
701
+
702
+ const configuration = new Configuration();
703
+ const apiInstance = new AccountsApi(configuration);
704
+
705
+ let id: string; //Account Xero ID (default to undefined)
706
+
707
+ const { status, data } = await apiInstance.getGetFinanceSettings(
708
+ id
709
+ );
710
+ ```
711
+
712
+ ### Parameters
713
+
714
+ |Name | Type | Description | Notes|
715
+ |------------- | ------------- | ------------- | -------------|
716
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
717
+
718
+
719
+ ### Return type
720
+
721
+ **AccountFinanceDTO**
722
+
723
+ ### Authorization
724
+
725
+ No authorization required
726
+
727
+ ### HTTP request headers
728
+
729
+ - **Content-Type**: Not defined
730
+ - **Accept**: application/json
731
+
732
+
733
+ ### HTTP response details
734
+ | Status code | Description | Response headers |
735
+ |-------------|-------------|------------------|
736
+ |**200** | Accounts Finance Details | - |
737
+ |**400** | Bad Request | - |
738
+ |**401** | Unauthorised | - |
739
+ |**403** | Access Denied | - |
740
+
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)
742
+
743
+ # **getGetLastAccount**
744
+ > AccountSummaryDTO getGetLastAccount()
745
+
746
+ Get Last Account
747
+
748
+ ### Example
749
+
750
+ ```typescript
751
+ import {
752
+ AccountsApi,
753
+ Configuration
754
+ } from 'yellowgrid-api-ts';
755
+
756
+ const configuration = new Configuration();
757
+ const apiInstance = new AccountsApi(configuration);
758
+
759
+ const { status, data } = await apiInstance.getGetLastAccount();
760
+ ```
761
+
762
+ ### Parameters
763
+ This endpoint does not have any parameters.
764
+
765
+
766
+ ### Return type
767
+
768
+ **AccountSummaryDTO**
769
+
770
+ ### Authorization
771
+
772
+ No authorization required
773
+
774
+ ### HTTP request headers
775
+
776
+ - **Content-Type**: Not defined
777
+ - **Accept**: application/json
778
+
779
+
780
+ ### HTTP response details
781
+ | Status code | Description | Response headers |
782
+ |-------------|-------------|------------------|
783
+ |**200** | Account Summary | - |
784
+ |**400** | Bad Request | - |
785
+ |**401** | Unauthorised | - |
786
+ |**403** | Access Denied | - |
787
+
788
+ [[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)
789
+
790
+ # **getGetTcxPartnerDetails**
791
+ > PartnerDTO getGetTcxPartnerDetails()
792
+
793
+ Get Account 3CX Details
794
+
795
+ ### Example
796
+
797
+ ```typescript
798
+ import {
799
+ AccountsApi,
800
+ Configuration
801
+ } from 'yellowgrid-api-ts';
802
+
803
+ const configuration = new Configuration();
804
+ const apiInstance = new AccountsApi(configuration);
805
+
806
+ let id: string; //Xero ID (default to undefined)
807
+
808
+ const { status, data } = await apiInstance.getGetTcxPartnerDetails(
809
+ id
810
+ );
811
+ ```
812
+
813
+ ### Parameters
814
+
815
+ |Name | Type | Description | Notes|
816
+ |------------- | ------------- | ------------- | -------------|
817
+ | **id** | [**string**] | Xero ID | defaults to undefined|
818
+
819
+
820
+ ### Return type
821
+
822
+ **PartnerDTO**
823
+
824
+ ### Authorization
825
+
826
+ No authorization required
827
+
828
+ ### HTTP request headers
829
+
830
+ - **Content-Type**: Not defined
831
+ - **Accept**: application/json
832
+
833
+
834
+ ### HTTP response details
835
+ | Status code | Description | Response headers |
836
+ |-------------|-------------|------------------|
837
+ |**200** | Account 3CX Partner Details | - |
838
+ |**400** | Bad Request | - |
839
+ |**401** | Unauthorised | - |
840
+ |**403** | Access Denied | - |
841
+
842
+ [[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)
843
+
844
+ # **getVerifyEmailAddress**
845
+ > getVerifyEmailAddress()
846
+
847
+ Verify account email address
848
+
849
+ ### Example
850
+
851
+ ```typescript
852
+ import {
853
+ AccountsApi,
854
+ Configuration
855
+ } from 'yellowgrid-api-ts';
856
+
857
+ const configuration = new Configuration();
858
+ const apiInstance = new AccountsApi(configuration);
859
+
860
+ let token: string; //Verification Token (default to undefined)
861
+
862
+ const { status, data } = await apiInstance.getVerifyEmailAddress(
863
+ token
864
+ );
865
+ ```
866
+
867
+ ### Parameters
868
+
869
+ |Name | Type | Description | Notes|
870
+ |------------- | ------------- | ------------- | -------------|
871
+ | **token** | [**string**] | Verification Token | defaults to undefined|
872
+
873
+
874
+ ### Return type
875
+
876
+ void (empty response body)
877
+
878
+ ### Authorization
879
+
880
+ No authorization required
881
+
882
+ ### HTTP request headers
883
+
884
+ - **Content-Type**: Not defined
885
+ - **Accept**: Not defined
886
+
887
+
888
+ ### HTTP response details
889
+ | Status code | Description | Response headers |
890
+ |-------------|-------------|------------------|
891
+ |**200** | No Response | - |
892
+ |**400** | Bad Request | - |
893
+ |**401** | Unauthorised | - |
894
+ |**403** | Access Denied | - |
895
+
896
+ [[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)
897
+
898
+ # **patchSetPortalAccess**
899
+ > patchSetPortalAccess()
900
+
901
+ Set Account Portal Access
902
+
903
+ ### Example
904
+
905
+ ```typescript
906
+ import {
907
+ AccountsApi,
908
+ Configuration
909
+ } from 'yellowgrid-api-ts';
910
+
911
+ const configuration = new Configuration();
912
+ const apiInstance = new AccountsApi(configuration);
913
+
914
+ let id: string; //Xero ID (default to undefined)
915
+ let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
916
+
917
+ const { status, data } = await apiInstance.patchSetPortalAccess(
918
+ id,
919
+ state
920
+ );
921
+ ```
922
+
923
+ ### Parameters
924
+
925
+ |Name | Type | Description | Notes|
926
+ |------------- | ------------- | ------------- | -------------|
927
+ | **id** | [**string**] | Xero ID | defaults to undefined|
928
+ | **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Portal Access State | defaults to undefined|
929
+
930
+
931
+ ### Return type
932
+
933
+ void (empty response body)
934
+
935
+ ### Authorization
936
+
937
+ No authorization required
938
+
939
+ ### HTTP request headers
940
+
941
+ - **Content-Type**: Not defined
942
+ - **Accept**: Not defined
943
+
944
+
945
+ ### HTTP response details
946
+ | Status code | Description | Response headers |
947
+ |-------------|-------------|------------------|
948
+ |**204** | No Response | - |
949
+ |**400** | Bad Request | - |
950
+ |**401** | Unauthorised | - |
951
+ |**403** | Access Denied | - |
952
+
953
+ [[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)
954
+
955
+ # **patchSetPrizePromo**
956
+ > patchSetPrizePromo()
957
+
958
+ Set Account Prize Promo
959
+
960
+ ### Example
961
+
962
+ ```typescript
963
+ import {
964
+ AccountsApi,
965
+ Configuration
966
+ } from 'yellowgrid-api-ts';
967
+
968
+ const configuration = new Configuration();
969
+ const apiInstance = new AccountsApi(configuration);
970
+
971
+ let id: string; //Xero ID (default to undefined)
972
+ let state: 'enable' | 'disable'; //Prize Promo State (default to undefined)
973
+
974
+ const { status, data } = await apiInstance.patchSetPrizePromo(
975
+ id,
976
+ state
977
+ );
978
+ ```
979
+
980
+ ### Parameters
981
+
982
+ |Name | Type | Description | Notes|
983
+ |------------- | ------------- | ------------- | -------------|
984
+ | **id** | [**string**] | Xero ID | defaults to undefined|
985
+ | **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Prize Promo State | defaults to undefined|
986
+
987
+
988
+ ### Return type
989
+
990
+ void (empty response body)
991
+
992
+ ### Authorization
993
+
994
+ No authorization required
995
+
996
+ ### HTTP request headers
997
+
998
+ - **Content-Type**: Not defined
999
+ - **Accept**: Not defined
1000
+
1001
+
1002
+ ### HTTP response details
1003
+ | Status code | Description | Response headers |
1004
+ |-------------|-------------|------------------|
1005
+ |**204** | No Response | - |
1006
+ |**400** | Bad Request | - |
1007
+ |**401** | Unauthorised | - |
1008
+ |**403** | Access Denied | - |
1009
+
1010
+ [[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)
1011
+
1012
+ # **patchSetTcxWizardCname**
1013
+ > patchSetTcxWizardCname()
1014
+
1015
+ Set 3CX Wizard CNAME
1016
+
1017
+ ### Example
1018
+
1019
+ ```typescript
1020
+ import {
1021
+ AccountsApi,
1022
+ Configuration,
1023
+ PatchUpdateAccountCnameRequest
1024
+ } from 'yellowgrid-api-ts';
1025
+
1026
+ const configuration = new Configuration();
1027
+ const apiInstance = new AccountsApi(configuration);
1028
+
1029
+ let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
1030
+
1031
+ const { status, data } = await apiInstance.patchSetTcxWizardCname(
1032
+ patchUpdateAccountCnameRequest
1033
+ );
1034
+ ```
1035
+
1036
+ ### Parameters
1037
+
1038
+ |Name | Type | Description | Notes|
1039
+ |------------- | ------------- | ------------- | -------------|
1040
+ | **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
1041
+
1042
+
1043
+ ### Return type
1044
+
1045
+ void (empty response body)
1046
+
1047
+ ### Authorization
1048
+
1049
+ No authorization required
1050
+
1051
+ ### HTTP request headers
1052
+
1053
+ - **Content-Type**: application/json
1054
+ - **Accept**: Not defined
1055
+
1056
+
1057
+ ### HTTP response details
1058
+ | Status code | Description | Response headers |
1059
+ |-------------|-------------|------------------|
1060
+ |**200** | No Response | - |
1061
+ |**400** | Bad Request | - |
1062
+ |**401** | Unauthorised | - |
1063
+ |**403** | Access Denied | - |
1064
+
1065
+ [[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)
1066
+
1067
+ # **patchUpdateAccountCname**
1068
+ > patchUpdateAccountCname()
1069
+
1070
+ Set Account CNAME
1071
+
1072
+ ### Example
1073
+
1074
+ ```typescript
1075
+ import {
1076
+ AccountsApi,
1077
+ Configuration,
1078
+ PatchUpdateAccountCnameRequest
1079
+ } from 'yellowgrid-api-ts';
1080
+
1081
+ const configuration = new Configuration();
1082
+ const apiInstance = new AccountsApi(configuration);
1083
+
1084
+ let id: string; //Xero ID (default to undefined)
1085
+ let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
1086
+
1087
+ const { status, data } = await apiInstance.patchUpdateAccountCname(
1088
+ id,
1089
+ patchUpdateAccountCnameRequest
1090
+ );
1091
+ ```
1092
+
1093
+ ### Parameters
1094
+
1095
+ |Name | Type | Description | Notes|
1096
+ |------------- | ------------- | ------------- | -------------|
1097
+ | **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
1098
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1099
+
1100
+
1101
+ ### Return type
1102
+
1103
+ void (empty response body)
1104
+
1105
+ ### Authorization
1106
+
1107
+ No authorization required
1108
+
1109
+ ### HTTP request headers
1110
+
1111
+ - **Content-Type**: application/json
1112
+ - **Accept**: Not defined
1113
+
1114
+
1115
+ ### HTTP response details
1116
+ | Status code | Description | Response headers |
1117
+ |-------------|-------------|------------------|
1118
+ |**204** | No Response | - |
1119
+ |**400** | Bad Request | - |
1120
+ |**401** | Unauthorised | - |
1121
+ |**403** | Access Denied | - |
1122
+
1123
+ [[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)
1124
+
1125
+ # **patchUpdateAccountCompanyNumber**
1126
+ > patchUpdateAccountCompanyNumber()
1127
+
1128
+ Set Account Company Number
1129
+
1130
+ ### Example
1131
+
1132
+ ```typescript
1133
+ import {
1134
+ AccountsApi,
1135
+ Configuration,
1136
+ PatchUpdateAccountCompanyNumberRequest
1137
+ } from 'yellowgrid-api-ts';
1138
+
1139
+ const configuration = new Configuration();
1140
+ const apiInstance = new AccountsApi(configuration);
1141
+
1142
+ let id: string; //Xero ID (default to undefined)
1143
+ let patchUpdateAccountCompanyNumberRequest: PatchUpdateAccountCompanyNumberRequest; //Account Company Number Request (optional)
1144
+
1145
+ const { status, data } = await apiInstance.patchUpdateAccountCompanyNumber(
1146
+ id,
1147
+ patchUpdateAccountCompanyNumberRequest
1148
+ );
1149
+ ```
1150
+
1151
+ ### Parameters
1152
+
1153
+ |Name | Type | Description | Notes|
1154
+ |------------- | ------------- | ------------- | -------------|
1155
+ | **patchUpdateAccountCompanyNumberRequest** | **PatchUpdateAccountCompanyNumberRequest**| Account Company Number Request | |
1156
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1157
+
1158
+
1159
+ ### Return type
1160
+
1161
+ void (empty response body)
1162
+
1163
+ ### Authorization
1164
+
1165
+ No authorization required
1166
+
1167
+ ### HTTP request headers
1168
+
1169
+ - **Content-Type**: application/json
1170
+ - **Accept**: Not defined
1171
+
1172
+
1173
+ ### HTTP response details
1174
+ | Status code | Description | Response headers |
1175
+ |-------------|-------------|------------------|
1176
+ |**204** | No Response | - |
1177
+ |**400** | Bad Request | - |
1178
+ |**401** | Unauthorised | - |
1179
+ |**403** | Access Denied | - |
1180
+
1181
+ [[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)
1182
+
1183
+ # **patchUpdateAccountContactPassword**
1184
+ > patchUpdateAccountContactPassword()
1185
+
1186
+ Update Account Password
1187
+
1188
+ ### Example
1189
+
1190
+ ```typescript
1191
+ import {
1192
+ AccountsApi,
1193
+ Configuration,
1194
+ PatchUpdateAccountContactPasswordRequest
1195
+ } from 'yellowgrid-api-ts';
1196
+
1197
+ const configuration = new Configuration();
1198
+ const apiInstance = new AccountsApi(configuration);
1199
+
1200
+ let token: string; //Verification Token (default to undefined)
1201
+ let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
1202
+
1203
+ const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
1204
+ token,
1205
+ patchUpdateAccountContactPasswordRequest
1206
+ );
1207
+ ```
1208
+
1209
+ ### Parameters
1210
+
1211
+ |Name | Type | Description | Notes|
1212
+ |------------- | ------------- | ------------- | -------------|
1213
+ | **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
1214
+ | **token** | [**string**] | Verification Token | defaults to undefined|
1215
+
1216
+
1217
+ ### Return type
1218
+
1219
+ void (empty response body)
1220
+
1221
+ ### Authorization
1222
+
1223
+ No authorization required
1224
+
1225
+ ### HTTP request headers
1226
+
1227
+ - **Content-Type**: application/json
1228
+ - **Accept**: Not defined
1229
+
1230
+
1231
+ ### HTTP response details
1232
+ | Status code | Description | Response headers |
1233
+ |-------------|-------------|------------------|
1234
+ |**200** | No Response | - |
1235
+ |**400** | Bad Request | - |
1236
+ |**401** | Unauthorised | - |
1237
+ |**403** | Access Denied | - |
1238
+
1239
+ [[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)
1240
+
1241
+ # **patchUpdateAccountPhone**
1242
+ > patchUpdateAccountPhone()
1243
+
1244
+ Set Account Phone
1245
+
1246
+ ### Example
1247
+
1248
+ ```typescript
1249
+ import {
1250
+ AccountsApi,
1251
+ Configuration,
1252
+ PatchUpdateAccountPhoneRequest
1253
+ } from 'yellowgrid-api-ts';
1254
+
1255
+ const configuration = new Configuration();
1256
+ const apiInstance = new AccountsApi(configuration);
1257
+
1258
+ let id: string; //Xero ID (default to undefined)
1259
+ let patchUpdateAccountPhoneRequest: PatchUpdateAccountPhoneRequest; //Telephone Request (optional)
1260
+
1261
+ const { status, data } = await apiInstance.patchUpdateAccountPhone(
1262
+ id,
1263
+ patchUpdateAccountPhoneRequest
1264
+ );
1265
+ ```
1266
+
1267
+ ### Parameters
1268
+
1269
+ |Name | Type | Description | Notes|
1270
+ |------------- | ------------- | ------------- | -------------|
1271
+ | **patchUpdateAccountPhoneRequest** | **PatchUpdateAccountPhoneRequest**| Telephone Request | |
1272
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1273
+
1274
+
1275
+ ### Return type
1276
+
1277
+ void (empty response body)
1278
+
1279
+ ### Authorization
1280
+
1281
+ No authorization required
1282
+
1283
+ ### HTTP request headers
1284
+
1285
+ - **Content-Type**: application/json
1286
+ - **Accept**: Not defined
1287
+
1288
+
1289
+ ### HTTP response details
1290
+ | Status code | Description | Response headers |
1291
+ |-------------|-------------|------------------|
1292
+ |**204** | No Response | - |
1293
+ |**400** | Bad Request | - |
1294
+ |**401** | Unauthorised | - |
1295
+ |**403** | Access Denied | - |
1296
+
1297
+ [[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)
1298
+
1299
+ # **patchUpdateAccountVatNumber**
1300
+ > patchUpdateAccountVatNumber()
1301
+
1302
+ Set Account VAT Number
1303
+
1304
+ ### Example
1305
+
1306
+ ```typescript
1307
+ import {
1308
+ AccountsApi,
1309
+ Configuration,
1310
+ PatchUpdateAccountVatNumberRequest
1311
+ } from 'yellowgrid-api-ts';
1312
+
1313
+ const configuration = new Configuration();
1314
+ const apiInstance = new AccountsApi(configuration);
1315
+
1316
+ let id: string; //Xero ID (default to undefined)
1317
+ let patchUpdateAccountVatNumberRequest: PatchUpdateAccountVatNumberRequest; //VAT Number Request (optional)
1318
+
1319
+ const { status, data } = await apiInstance.patchUpdateAccountVatNumber(
1320
+ id,
1321
+ patchUpdateAccountVatNumberRequest
1322
+ );
1323
+ ```
1324
+
1325
+ ### Parameters
1326
+
1327
+ |Name | Type | Description | Notes|
1328
+ |------------- | ------------- | ------------- | -------------|
1329
+ | **patchUpdateAccountVatNumberRequest** | **PatchUpdateAccountVatNumberRequest**| VAT Number Request | |
1330
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1331
+
1332
+
1333
+ ### Return type
1334
+
1335
+ void (empty response body)
1336
+
1337
+ ### Authorization
1338
+
1339
+ No authorization required
1340
+
1341
+ ### HTTP request headers
1342
+
1343
+ - **Content-Type**: application/json
1344
+ - **Accept**: Not defined
1345
+
1346
+
1347
+ ### HTTP response details
1348
+ | Status code | Description | Response headers |
1349
+ |-------------|-------------|------------------|
1350
+ |**204** | No Response | - |
1351
+ |**400** | Bad Request | - |
1352
+ |**401** | Unauthorised | - |
1353
+ |**403** | Access Denied | - |
1354
+
1355
+ [[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)
1356
+
1357
+ # **patchUpdateCreditLimit**
1358
+ > AccountFinanceDTO patchUpdateCreditLimit()
1359
+
1360
+ Set Account Credit Limit
1361
+
1362
+ ### Example
1363
+
1364
+ ```typescript
1365
+ import {
1366
+ AccountsApi,
1367
+ Configuration,
1368
+ PatchUpdateCreditLimitRequest
1369
+ } from 'yellowgrid-api-ts';
1370
+
1371
+ const configuration = new Configuration();
1372
+ const apiInstance = new AccountsApi(configuration);
1373
+
1374
+ let id: string; //Xero ID (default to undefined)
1375
+ let patchUpdateCreditLimitRequest: PatchUpdateCreditLimitRequest; //Credit Limit Request (optional)
1376
+
1377
+ const { status, data } = await apiInstance.patchUpdateCreditLimit(
1378
+ id,
1379
+ patchUpdateCreditLimitRequest
1380
+ );
1381
+ ```
1382
+
1383
+ ### Parameters
1384
+
1385
+ |Name | Type | Description | Notes|
1386
+ |------------- | ------------- | ------------- | -------------|
1387
+ | **patchUpdateCreditLimitRequest** | **PatchUpdateCreditLimitRequest**| Credit Limit Request | |
1388
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1389
+
1390
+
1391
+ ### Return type
1392
+
1393
+ **AccountFinanceDTO**
1394
+
1395
+ ### Authorization
1396
+
1397
+ No authorization required
1398
+
1399
+ ### HTTP request headers
1400
+
1401
+ - **Content-Type**: application/json
1402
+ - **Accept**: application/json
1403
+
1404
+
1405
+ ### HTTP response details
1406
+ | Status code | Description | Response headers |
1407
+ |-------------|-------------|------------------|
1408
+ |**200** | Accounts Finance Details | - |
1409
+ |**400** | Bad Request | - |
1410
+ |**401** | Unauthorised | - |
1411
+ |**403** | Access Denied | - |
1412
+
1413
+ [[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)
1414
+
1415
+ # **patchUpdatePriceList**
1416
+ > AccountFinanceDTO patchUpdatePriceList()
355
1417
 
356
- Get user\'s client credentials
1418
+ Set Account Price List
357
1419
 
358
1420
  ### Example
359
1421
 
360
1422
  ```typescript
361
1423
  import {
362
1424
  AccountsApi,
363
- Configuration
1425
+ Configuration,
1426
+ PatchUpdatePriceListRequest
364
1427
  } from 'yellowgrid-api-ts';
365
1428
 
366
1429
  const configuration = new Configuration();
367
1430
  const apiInstance = new AccountsApi(configuration);
368
1431
 
369
- const { status, data } = await apiInstance.getGetClientCredentials();
1432
+ let id: string; //Xero ID (default to undefined)
1433
+ let patchUpdatePriceListRequest: PatchUpdatePriceListRequest; //Price List Request (optional)
1434
+
1435
+ const { status, data } = await apiInstance.patchUpdatePriceList(
1436
+ id,
1437
+ patchUpdatePriceListRequest
1438
+ );
370
1439
  ```
371
1440
 
372
1441
  ### Parameters
373
- This endpoint does not have any parameters.
1442
+
1443
+ |Name | Type | Description | Notes|
1444
+ |------------- | ------------- | ------------- | -------------|
1445
+ | **patchUpdatePriceListRequest** | **PatchUpdatePriceListRequest**| Price List Request | |
1446
+ | **id** | [**string**] | Xero ID | defaults to undefined|
374
1447
 
375
1448
 
376
1449
  ### Return type
377
1450
 
378
- **Array<ClientModel>**
1451
+ **AccountFinanceDTO**
379
1452
 
380
1453
  ### Authorization
381
1454
 
@@ -383,46 +1456,57 @@ No authorization required
383
1456
 
384
1457
  ### HTTP request headers
385
1458
 
386
- - **Content-Type**: Not defined
1459
+ - **Content-Type**: application/json
387
1460
  - **Accept**: application/json
388
1461
 
389
1462
 
390
1463
  ### HTTP response details
391
1464
  | Status code | Description | Response headers |
392
1465
  |-------------|-------------|------------------|
393
- |**200** | List of client credentials | - |
1466
+ |**200** | Accounts Finance Details | - |
394
1467
  |**400** | Bad Request | - |
395
1468
  |**401** | Unauthorised | - |
396
1469
  |**403** | Access Denied | - |
397
1470
 
398
1471
  [[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)
399
1472
 
400
- # **getGetCustomerKeys**
401
- > Array<TcxKeySummaryDTO> getGetCustomerKeys()
1473
+ # **patchUpdateSipChannelCost**
1474
+ > AccountFinanceDTO patchUpdateSipChannelCost()
402
1475
 
403
- Get 3CX Keys
1476
+ Set Account SIP Channel Cost
404
1477
 
405
1478
  ### Example
406
1479
 
407
1480
  ```typescript
408
1481
  import {
409
1482
  AccountsApi,
410
- Configuration
1483
+ Configuration,
1484
+ PatchUpdateSipChannelCostRequest
411
1485
  } from 'yellowgrid-api-ts';
412
1486
 
413
1487
  const configuration = new Configuration();
414
1488
  const apiInstance = new AccountsApi(configuration);
415
1489
 
416
- const { status, data } = await apiInstance.getGetCustomerKeys();
1490
+ let id: string; //Xero ID (default to undefined)
1491
+ let patchUpdateSipChannelCostRequest: PatchUpdateSipChannelCostRequest; //SIP Channel Cost Request (optional)
1492
+
1493
+ const { status, data } = await apiInstance.patchUpdateSipChannelCost(
1494
+ id,
1495
+ patchUpdateSipChannelCostRequest
1496
+ );
417
1497
  ```
418
1498
 
419
1499
  ### Parameters
420
- This endpoint does not have any parameters.
1500
+
1501
+ |Name | Type | Description | Notes|
1502
+ |------------- | ------------- | ------------- | -------------|
1503
+ | **patchUpdateSipChannelCostRequest** | **PatchUpdateSipChannelCostRequest**| SIP Channel Cost Request | |
1504
+ | **id** | [**string**] | Xero ID | defaults to undefined|
421
1505
 
422
1506
 
423
1507
  ### Return type
424
1508
 
425
- **Array<TcxKeySummaryDTO>**
1509
+ **AccountFinanceDTO**
426
1510
 
427
1511
  ### Authorization
428
1512
 
@@ -430,40 +1514,43 @@ No authorization required
430
1514
 
431
1515
  ### HTTP request headers
432
1516
 
433
- - **Content-Type**: Not defined
1517
+ - **Content-Type**: application/json
434
1518
  - **Accept**: application/json
435
1519
 
436
1520
 
437
1521
  ### HTTP response details
438
1522
  | Status code | Description | Response headers |
439
1523
  |-------------|-------------|------------------|
440
- |**200** | 3CX Key Summaries | - |
1524
+ |**200** | Accounts Finance Details | - |
441
1525
  |**400** | Bad Request | - |
442
1526
  |**401** | Unauthorised | - |
443
1527
  |**403** | Access Denied | - |
444
1528
 
445
1529
  [[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)
446
1530
 
447
- # **getVerifyEmailAddress**
448
- > getVerifyEmailAddress()
1531
+ # **patchUpdateTcxHostingPriceList**
1532
+ > PartnerDTO patchUpdateTcxHostingPriceList()
449
1533
 
450
- Verify account email address
1534
+ Set Account 3CX Hosting Price List
451
1535
 
452
1536
  ### Example
453
1537
 
454
1538
  ```typescript
455
1539
  import {
456
1540
  AccountsApi,
457
- Configuration
1541
+ Configuration,
1542
+ PatchUpdateTcxHostingPriceListRequest
458
1543
  } from 'yellowgrid-api-ts';
459
1544
 
460
1545
  const configuration = new Configuration();
461
1546
  const apiInstance = new AccountsApi(configuration);
462
1547
 
463
- let token: string; //Verification Token (default to undefined)
1548
+ let id: string; //Xero ID (default to undefined)
1549
+ let patchUpdateTcxHostingPriceListRequest: PatchUpdateTcxHostingPriceListRequest; //3CX Hosting Price List Request (optional)
464
1550
 
465
- const { status, data } = await apiInstance.getVerifyEmailAddress(
466
- token
1551
+ const { status, data } = await apiInstance.patchUpdateTcxHostingPriceList(
1552
+ id,
1553
+ patchUpdateTcxHostingPriceListRequest
467
1554
  );
468
1555
  ```
469
1556
 
@@ -471,12 +1558,13 @@ const { status, data } = await apiInstance.getVerifyEmailAddress(
471
1558
 
472
1559
  |Name | Type | Description | Notes|
473
1560
  |------------- | ------------- | ------------- | -------------|
474
- | **token** | [**string**] | Verification Token | defaults to undefined|
1561
+ | **patchUpdateTcxHostingPriceListRequest** | **PatchUpdateTcxHostingPriceListRequest**| 3CX Hosting Price List Request | |
1562
+ | **id** | [**string**] | Xero ID | defaults to undefined|
475
1563
 
476
1564
 
477
1565
  ### Return type
478
1566
 
479
- void (empty response body)
1567
+ **PartnerDTO**
480
1568
 
481
1569
  ### Authorization
482
1570
 
@@ -484,24 +1572,24 @@ No authorization required
484
1572
 
485
1573
  ### HTTP request headers
486
1574
 
487
- - **Content-Type**: Not defined
488
- - **Accept**: Not defined
1575
+ - **Content-Type**: application/json
1576
+ - **Accept**: application/json
489
1577
 
490
1578
 
491
1579
  ### HTTP response details
492
1580
  | Status code | Description | Response headers |
493
1581
  |-------------|-------------|------------------|
494
- |**200** | No Response | - |
1582
+ |**200** | Account 3CX Partner Details | - |
495
1583
  |**400** | Bad Request | - |
496
1584
  |**401** | Unauthorised | - |
497
1585
  |**403** | Access Denied | - |
498
1586
 
499
1587
  [[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)
500
1588
 
501
- # **patchSetTcxWizardCname**
502
- > patchSetTcxWizardCname()
1589
+ # **patchUpdateTcxPartnerId**
1590
+ > PartnerDTO patchUpdateTcxPartnerId()
503
1591
 
504
- Set 3CX Wizard CNAME
1592
+ Set Account 3CX Partner ID
505
1593
 
506
1594
  ### Example
507
1595
 
@@ -509,16 +1597,18 @@ Set 3CX Wizard CNAME
509
1597
  import {
510
1598
  AccountsApi,
511
1599
  Configuration,
512
- PatchSetTcxWizardCnameRequest
1600
+ PatchUpdateTcxPartnerIdRequest
513
1601
  } from 'yellowgrid-api-ts';
514
1602
 
515
1603
  const configuration = new Configuration();
516
1604
  const apiInstance = new AccountsApi(configuration);
517
1605
 
518
- let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
1606
+ let id: string; //Xero ID (default to undefined)
1607
+ let patchUpdateTcxPartnerIdRequest: PatchUpdateTcxPartnerIdRequest; //Set Account 3CX Partner ID (optional)
519
1608
 
520
- const { status, data } = await apiInstance.patchSetTcxWizardCname(
521
- patchSetTcxWizardCnameRequest
1609
+ const { status, data } = await apiInstance.patchUpdateTcxPartnerId(
1610
+ id,
1611
+ patchUpdateTcxPartnerIdRequest
522
1612
  );
523
1613
  ```
524
1614
 
@@ -526,12 +1616,13 @@ const { status, data } = await apiInstance.patchSetTcxWizardCname(
526
1616
 
527
1617
  |Name | Type | Description | Notes|
528
1618
  |------------- | ------------- | ------------- | -------------|
529
- | **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
1619
+ | **patchUpdateTcxPartnerIdRequest** | **PatchUpdateTcxPartnerIdRequest**| Set Account 3CX Partner ID | |
1620
+ | **id** | [**string**] | Xero ID | defaults to undefined|
530
1621
 
531
1622
 
532
1623
  ### Return type
533
1624
 
534
- void (empty response body)
1625
+ **PartnerDTO**
535
1626
 
536
1627
  ### Authorization
537
1628
 
@@ -540,23 +1631,23 @@ No authorization required
540
1631
  ### HTTP request headers
541
1632
 
542
1633
  - **Content-Type**: application/json
543
- - **Accept**: Not defined
1634
+ - **Accept**: application/json
544
1635
 
545
1636
 
546
1637
  ### HTTP response details
547
1638
  | Status code | Description | Response headers |
548
1639
  |-------------|-------------|------------------|
549
- |**200** | No Response | - |
1640
+ |**200** | Account 3CX Partner Details | - |
550
1641
  |**400** | Bad Request | - |
551
1642
  |**401** | Unauthorised | - |
552
1643
  |**403** | Access Denied | - |
553
1644
 
554
1645
  [[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)
555
1646
 
556
- # **patchUpdateAccountContactPassword**
557
- > patchUpdateAccountContactPassword()
1647
+ # **postAdminCreateAccountContact**
1648
+ > postAdminCreateAccountContact()
558
1649
 
559
- Update Account Password
1650
+ Create Account Contact
560
1651
 
561
1652
  ### Example
562
1653
 
@@ -564,18 +1655,18 @@ Update Account Password
564
1655
  import {
565
1656
  AccountsApi,
566
1657
  Configuration,
567
- PatchUpdateAccountContactPasswordRequest
1658
+ AccountContactRequestModel
568
1659
  } from 'yellowgrid-api-ts';
569
1660
 
570
1661
  const configuration = new Configuration();
571
1662
  const apiInstance = new AccountsApi(configuration);
572
1663
 
573
- let token: string; //Verification Token (default to undefined)
574
- let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
1664
+ let id: string; //Account Xero ID (default to undefined)
1665
+ let accountContactRequestModel: AccountContactRequestModel; //Create Account Contact Request (optional)
575
1666
 
576
- const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
577
- token,
578
- patchUpdateAccountContactPasswordRequest
1667
+ const { status, data } = await apiInstance.postAdminCreateAccountContact(
1668
+ id,
1669
+ accountContactRequestModel
579
1670
  );
580
1671
  ```
581
1672
 
@@ -583,8 +1674,8 @@ const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
583
1674
 
584
1675
  |Name | Type | Description | Notes|
585
1676
  |------------- | ------------- | ------------- | -------------|
586
- | **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
587
- | **token** | [**string**] | Verification Token | defaults to undefined|
1677
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Create Account Contact Request | |
1678
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
588
1679
 
589
1680
 
590
1681
  ### Return type
@@ -604,7 +1695,7 @@ No authorization required
604
1695
  ### HTTP response details
605
1696
  | Status code | Description | Response headers |
606
1697
  |-------------|-------------|------------------|
607
- |**200** | No Response | - |
1698
+ |**201** | No Response | - |
608
1699
  |**400** | Bad Request | - |
609
1700
  |**401** | Unauthorised | - |
610
1701
  |**403** | Access Denied | - |
@@ -921,6 +2012,64 @@ No authorization required
921
2012
  - **Accept**: Not defined
922
2013
 
923
2014
 
2015
+ ### HTTP response details
2016
+ | Status code | Description | Response headers |
2017
+ |-------------|-------------|------------------|
2018
+ |**200** | No Response | - |
2019
+ |**400** | Bad Request | - |
2020
+ |**401** | Unauthorised | - |
2021
+ |**403** | Access Denied | - |
2022
+
2023
+ [[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)
2024
+
2025
+ # **postSendWelcomeEmail**
2026
+ > postSendWelcomeEmail()
2027
+
2028
+ Send Account Welcome Email
2029
+
2030
+ ### Example
2031
+
2032
+ ```typescript
2033
+ import {
2034
+ AccountsApi,
2035
+ Configuration,
2036
+ PostSendWelcomeEmailRequest
2037
+ } from 'yellowgrid-api-ts';
2038
+
2039
+ const configuration = new Configuration();
2040
+ const apiInstance = new AccountsApi(configuration);
2041
+
2042
+ let id: string; //Xero ID (default to undefined)
2043
+ let postSendWelcomeEmailRequest: PostSendWelcomeEmailRequest; //Email Request (optional)
2044
+
2045
+ const { status, data } = await apiInstance.postSendWelcomeEmail(
2046
+ id,
2047
+ postSendWelcomeEmailRequest
2048
+ );
2049
+ ```
2050
+
2051
+ ### Parameters
2052
+
2053
+ |Name | Type | Description | Notes|
2054
+ |------------- | ------------- | ------------- | -------------|
2055
+ | **postSendWelcomeEmailRequest** | **PostSendWelcomeEmailRequest**| Email Request | |
2056
+ | **id** | [**string**] | Xero ID | defaults to undefined|
2057
+
2058
+
2059
+ ### Return type
2060
+
2061
+ void (empty response body)
2062
+
2063
+ ### Authorization
2064
+
2065
+ No authorization required
2066
+
2067
+ ### HTTP request headers
2068
+
2069
+ - **Content-Type**: application/json
2070
+ - **Accept**: Not defined
2071
+
2072
+
924
2073
  ### HTTP response details
925
2074
  | Status code | Description | Response headers |
926
2075
  |-------------|-------------|------------------|
@@ -991,6 +2140,67 @@ No authorization required
991
2140
 
992
2141
  [[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)
993
2142
 
2143
+ # **putAdminUpdateAccountContact**
2144
+ > putAdminUpdateAccountContact()
2145
+
2146
+ Update Account Contact
2147
+
2148
+ ### Example
2149
+
2150
+ ```typescript
2151
+ import {
2152
+ AccountsApi,
2153
+ Configuration,
2154
+ AccountContactRequestModel
2155
+ } from 'yellowgrid-api-ts';
2156
+
2157
+ const configuration = new Configuration();
2158
+ const apiInstance = new AccountsApi(configuration);
2159
+
2160
+ let id: string; //Account Xero ID (default to undefined)
2161
+ let contactId: number; //Contact ID (default to undefined)
2162
+ let accountContactRequestModel: AccountContactRequestModel; //Update Account Contact Request (optional)
2163
+
2164
+ const { status, data } = await apiInstance.putAdminUpdateAccountContact(
2165
+ id,
2166
+ contactId,
2167
+ accountContactRequestModel
2168
+ );
2169
+ ```
2170
+
2171
+ ### Parameters
2172
+
2173
+ |Name | Type | Description | Notes|
2174
+ |------------- | ------------- | ------------- | -------------|
2175
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
2176
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
2177
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
2178
+
2179
+
2180
+ ### Return type
2181
+
2182
+ void (empty response body)
2183
+
2184
+ ### Authorization
2185
+
2186
+ No authorization required
2187
+
2188
+ ### HTTP request headers
2189
+
2190
+ - **Content-Type**: application/json
2191
+ - **Accept**: Not defined
2192
+
2193
+
2194
+ ### HTTP response details
2195
+ | Status code | Description | Response headers |
2196
+ |-------------|-------------|------------------|
2197
+ |**204** | No Response | - |
2198
+ |**400** | Bad Request | - |
2199
+ |**401** | Unauthorised | - |
2200
+ |**403** | Access Denied | - |
2201
+
2202
+ [[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)
2203
+
994
2204
  # **putUpdateAccountContact**
995
2205
  > putUpdateAccountContact()
996
2206
 
@@ -1049,3 +2259,119 @@ No authorization required
1049
2259
 
1050
2260
  [[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)
1051
2261
 
2262
+ # **putUpdateBillingAddress**
2263
+ > putUpdateBillingAddress()
2264
+
2265
+ Update Account Billing Address
2266
+
2267
+ ### Example
2268
+
2269
+ ```typescript
2270
+ import {
2271
+ AccountsApi,
2272
+ Configuration,
2273
+ AddressDTO
2274
+ } from 'yellowgrid-api-ts';
2275
+
2276
+ const configuration = new Configuration();
2277
+ const apiInstance = new AccountsApi(configuration);
2278
+
2279
+ let id: string; //Xero ID (default to undefined)
2280
+ let addressDTO: AddressDTO; //Updated Billing Address (optional)
2281
+
2282
+ const { status, data } = await apiInstance.putUpdateBillingAddress(
2283
+ id,
2284
+ addressDTO
2285
+ );
2286
+ ```
2287
+
2288
+ ### Parameters
2289
+
2290
+ |Name | Type | Description | Notes|
2291
+ |------------- | ------------- | ------------- | -------------|
2292
+ | **addressDTO** | **AddressDTO**| Updated Billing Address | |
2293
+ | **id** | [**string**] | Xero ID | defaults to undefined|
2294
+
2295
+
2296
+ ### Return type
2297
+
2298
+ void (empty response body)
2299
+
2300
+ ### Authorization
2301
+
2302
+ No authorization required
2303
+
2304
+ ### HTTP request headers
2305
+
2306
+ - **Content-Type**: application/json
2307
+ - **Accept**: Not defined
2308
+
2309
+
2310
+ ### HTTP response details
2311
+ | Status code | Description | Response headers |
2312
+ |-------------|-------------|------------------|
2313
+ |**204** | No Response | - |
2314
+ |**400** | Bad Request | - |
2315
+ |**401** | Unauthorised | - |
2316
+ |**403** | Access Denied | - |
2317
+
2318
+ [[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)
2319
+
2320
+ # **putUpdateShippingAddress**
2321
+ > putUpdateShippingAddress()
2322
+
2323
+ Update Account Shipping Address
2324
+
2325
+ ### Example
2326
+
2327
+ ```typescript
2328
+ import {
2329
+ AccountsApi,
2330
+ Configuration,
2331
+ AddressDTO
2332
+ } from 'yellowgrid-api-ts';
2333
+
2334
+ const configuration = new Configuration();
2335
+ const apiInstance = new AccountsApi(configuration);
2336
+
2337
+ let id: string; //Xero ID (default to undefined)
2338
+ let addressDTO: AddressDTO; //Updated Shipping Address (optional)
2339
+
2340
+ const { status, data } = await apiInstance.putUpdateShippingAddress(
2341
+ id,
2342
+ addressDTO
2343
+ );
2344
+ ```
2345
+
2346
+ ### Parameters
2347
+
2348
+ |Name | Type | Description | Notes|
2349
+ |------------- | ------------- | ------------- | -------------|
2350
+ | **addressDTO** | **AddressDTO**| Updated Shipping Address | |
2351
+ | **id** | [**string**] | Xero ID | defaults to undefined|
2352
+
2353
+
2354
+ ### Return type
2355
+
2356
+ void (empty response body)
2357
+
2358
+ ### Authorization
2359
+
2360
+ No authorization required
2361
+
2362
+ ### HTTP request headers
2363
+
2364
+ - **Content-Type**: application/json
2365
+ - **Accept**: Not defined
2366
+
2367
+
2368
+ ### HTTP response details
2369
+ | Status code | Description | Response headers |
2370
+ |-------------|-------------|------------------|
2371
+ |**204** | No Response | - |
2372
+ |**400** | Bad Request | - |
2373
+ |**401** | Unauthorised | - |
2374
+ |**403** | Access Denied | - |
2375
+
2376
+ [[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)
2377
+