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

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