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

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 (97) hide show
  1. package/.openapi-generator/FILES +293 -270
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +56 -3
  4. package/api.ts +3432 -5391
  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 +1541 -4530
  10. package/dist/api.js +3356 -1030
  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/CourierEnum.d.ts +5 -0
  20. package/dist/models/CourierEnum.js +5 -0
  21. package/docs/AbstractOrderRequestDTO.md +1 -1
  22. package/docs/AccountAddressesDTO.md +25 -0
  23. package/docs/AccountFinanceDTO.md +39 -0
  24. package/docs/AccountsApi.md +1486 -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 +66 -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 +45 -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 +41 -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/PutTransferConnectionRequest.md +20 -0
  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/CourierEnum.ts +5 -0
  85. package/openapitools.json +1 -1
  86. package/package.json +2 -2
  87. package/dist/models/GroupEnum.d.ts +0 -43
  88. package/dist/models/GroupEnum.js +0 -45
  89. package/docs/NumberPortModel.md +0 -51
  90. package/docs/PostGetProductRequest.md +0 -24
  91. package/docs/TcxInstallationDetailsModel.md +0 -45
  92. package/docs/TelephonySupportTicketModel.md +0 -41
  93. package/hs_err_pid16044.log +0 -249
  94. package/hs_err_pid44560.log +0 -249
  95. package/hs_err_pid53988.log +0 -249
  96. package/hs_err_pid58728.log +0 -40
  97. package/models/GroupEnum.ts +0 -44
@@ -1,28 +1,164 @@
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
+ |[**patchSetAccountStatus**](#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | |
25
+ |[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
26
+ |[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
16
27
  |[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
28
+ |[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
29
+ |[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
17
30
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
31
+ |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
32
+ |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
33
+ |[**patchUpdateCreditLimit**](#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | |
34
+ |[**patchUpdatePriceList**](#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | |
35
+ |[**patchUpdateSipChannelCost**](#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | |
36
+ |[**patchUpdateTcxHostingPriceList**](#patchupdatetcxhostingpricelist) | **PATCH** /admin/accounts/{id}/tcx/hosting/priceList | |
37
+ |[**patchUpdateTcxPartnerId**](#patchupdatetcxpartnerid) | **PATCH** /admin/accounts{id}/tcx/partner/id | |
38
+ |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | |
18
39
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
19
40
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
20
41
  |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
21
42
  |[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
22
43
  |[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
23
44
  |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
45
+ |[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
24
46
  |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
47
+ |[**putAdminUpdateAccountContact**](#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
25
48
  |[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
49
+ |[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
50
+ |[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
51
+
52
+ # **deleteAdminUpdateAccountContact**
53
+ > deleteAdminUpdateAccountContact()
54
+
55
+ Delete Account Contact
56
+
57
+ ### Example
58
+
59
+ ```typescript
60
+ import {
61
+ AccountsApi,
62
+ Configuration
63
+ } from 'yellowgrid-api-ts';
64
+
65
+ const configuration = new Configuration();
66
+ const apiInstance = new AccountsApi(configuration);
67
+
68
+ let id: string; //Account Xero ID (default to undefined)
69
+ let contactId: number; //Contact ID (default to undefined)
70
+
71
+ const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
72
+ id,
73
+ contactId
74
+ );
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ |Name | Type | Description | Notes|
80
+ |------------- | ------------- | ------------- | -------------|
81
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
82
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
83
+
84
+
85
+ ### Return type
86
+
87
+ void (empty response body)
88
+
89
+ ### Authorization
90
+
91
+ No authorization required
92
+
93
+ ### HTTP request headers
94
+
95
+ - **Content-Type**: Not defined
96
+ - **Accept**: Not defined
97
+
98
+
99
+ ### HTTP response details
100
+ | Status code | Description | Response headers |
101
+ |-------------|-------------|------------------|
102
+ |**204** | No Response | - |
103
+ |**400** | Bad Request | - |
104
+ |**401** | Unauthorised | - |
105
+ |**403** | Access Denied | - |
106
+
107
+ [[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)
108
+
109
+ # **deleteArchiveAccount**
110
+ > deleteArchiveAccount()
111
+
112
+ Delete Account
113
+
114
+ ### Example
115
+
116
+ ```typescript
117
+ import {
118
+ AccountsApi,
119
+ Configuration
120
+ } from 'yellowgrid-api-ts';
121
+
122
+ const configuration = new Configuration();
123
+ const apiInstance = new AccountsApi(configuration);
124
+
125
+ let id: string; //Account Xero ID (default to undefined)
126
+
127
+ const { status, data } = await apiInstance.deleteArchiveAccount(
128
+ id
129
+ );
130
+ ```
131
+
132
+ ### Parameters
133
+
134
+ |Name | Type | Description | Notes|
135
+ |------------- | ------------- | ------------- | -------------|
136
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
137
+
138
+
139
+ ### Return type
140
+
141
+ void (empty response body)
142
+
143
+ ### Authorization
144
+
145
+ No authorization required
146
+
147
+ ### HTTP request headers
148
+
149
+ - **Content-Type**: Not defined
150
+ - **Accept**: Not defined
151
+
152
+
153
+ ### HTTP response details
154
+ | Status code | Description | Response headers |
155
+ |-------------|-------------|------------------|
156
+ |**204** | No Response | - |
157
+ |**400** | Bad Request | - |
158
+ |**401** | Unauthorised | - |
159
+ |**403** | Access Denied | - |
160
+
161
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
26
162
 
27
163
  # **deleteDeleteClientCredentials**
28
164
  > deleteDeleteClientCredentials()
@@ -132,6 +268,60 @@ No authorization required
132
268
 
133
269
  [[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
270
 
271
+ # **getAdminCreateAccountContact**
272
+ > Array<AccountContactModel> getAdminCreateAccountContact()
273
+
274
+ Get Account Contacts
275
+
276
+ ### Example
277
+
278
+ ```typescript
279
+ import {
280
+ AccountsApi,
281
+ Configuration
282
+ } from 'yellowgrid-api-ts';
283
+
284
+ const configuration = new Configuration();
285
+ const apiInstance = new AccountsApi(configuration);
286
+
287
+ let id: string; //Account Xero ID (default to undefined)
288
+
289
+ const { status, data } = await apiInstance.getAdminCreateAccountContact(
290
+ id
291
+ );
292
+ ```
293
+
294
+ ### Parameters
295
+
296
+ |Name | Type | Description | Notes|
297
+ |------------- | ------------- | ------------- | -------------|
298
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
299
+
300
+
301
+ ### Return type
302
+
303
+ **Array<AccountContactModel>**
304
+
305
+ ### Authorization
306
+
307
+ No authorization required
308
+
309
+ ### HTTP request headers
310
+
311
+ - **Content-Type**: Not defined
312
+ - **Accept**: application/json
313
+
314
+
315
+ ### HTTP response details
316
+ | Status code | Description | Response headers |
317
+ |-------------|-------------|------------------|
318
+ |**200** | Account | - |
319
+ |**400** | Bad Request | - |
320
+ |**401** | Unauthorised | - |
321
+ |**403** | Access Denied | - |
322
+
323
+ [[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)
324
+
135
325
  # **getGetAccount**
136
326
  > PortalAccountModel getGetAccount()
137
327
 
@@ -179,6 +369,60 @@ No authorization required
179
369
 
180
370
  [[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
371
 
372
+ # **getGetAccountAddresses**
373
+ > AccountAddressesDTO getGetAccountAddresses()
374
+
375
+ Get Account Addresses
376
+
377
+ ### Example
378
+
379
+ ```typescript
380
+ import {
381
+ AccountsApi,
382
+ Configuration
383
+ } from 'yellowgrid-api-ts';
384
+
385
+ const configuration = new Configuration();
386
+ const apiInstance = new AccountsApi(configuration);
387
+
388
+ let id: string; //Xero ID (default to undefined)
389
+
390
+ const { status, data } = await apiInstance.getGetAccountAddresses(
391
+ id
392
+ );
393
+ ```
394
+
395
+ ### Parameters
396
+
397
+ |Name | Type | Description | Notes|
398
+ |------------- | ------------- | ------------- | -------------|
399
+ | **id** | [**string**] | Xero ID | defaults to undefined|
400
+
401
+
402
+ ### Return type
403
+
404
+ **AccountAddressesDTO**
405
+
406
+ ### Authorization
407
+
408
+ No authorization required
409
+
410
+ ### HTTP request headers
411
+
412
+ - **Content-Type**: Not defined
413
+ - **Accept**: application/json
414
+
415
+
416
+ ### HTTP response details
417
+ | Status code | Description | Response headers |
418
+ |-------------|-------------|------------------|
419
+ |**200** | Account Addresses | - |
420
+ |**400** | Bad Request | - |
421
+ |**401** | Unauthorised | - |
422
+ |**403** | Access Denied | - |
423
+
424
+ [[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)
425
+
182
426
  # **getGetAccountContacts**
183
427
  > Array<AccountContactModel> getGetAccountContacts()
184
428
 
@@ -350,32 +594,967 @@ No authorization required
350
594
 
351
595
  [[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
596
 
353
- # **getGetClientCredentials**
354
- > Array<ClientModel> getGetClientCredentials()
597
+ # **getGetClientCredentials**
598
+ > Array<ClientModel> getGetClientCredentials()
599
+
600
+ Get user\'s client credentials
601
+
602
+ ### Example
603
+
604
+ ```typescript
605
+ import {
606
+ AccountsApi,
607
+ Configuration
608
+ } from 'yellowgrid-api-ts';
609
+
610
+ const configuration = new Configuration();
611
+ const apiInstance = new AccountsApi(configuration);
612
+
613
+ const { status, data } = await apiInstance.getGetClientCredentials();
614
+ ```
615
+
616
+ ### Parameters
617
+ This endpoint does not have any parameters.
618
+
619
+
620
+ ### Return type
621
+
622
+ **Array<ClientModel>**
623
+
624
+ ### Authorization
625
+
626
+ No authorization required
627
+
628
+ ### HTTP request headers
629
+
630
+ - **Content-Type**: Not defined
631
+ - **Accept**: application/json
632
+
633
+
634
+ ### HTTP response details
635
+ | Status code | Description | Response headers |
636
+ |-------------|-------------|------------------|
637
+ |**200** | List of client credentials | - |
638
+ |**400** | Bad Request | - |
639
+ |**401** | Unauthorised | - |
640
+ |**403** | Access Denied | - |
641
+
642
+ [[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)
643
+
644
+ # **getGetCustomerAccountsList**
645
+ > Array<CustomerListAccountDTO> getGetCustomerAccountsList()
646
+
647
+ Get Customer Accounts List
648
+
649
+ ### Example
650
+
651
+ ```typescript
652
+ import {
653
+ AccountsApi,
654
+ Configuration
655
+ } from 'yellowgrid-api-ts';
656
+
657
+ const configuration = new Configuration();
658
+ const apiInstance = new AccountsApi(configuration);
659
+
660
+ const { status, data } = await apiInstance.getGetCustomerAccountsList();
661
+ ```
662
+
663
+ ### Parameters
664
+ This endpoint does not have any parameters.
665
+
666
+
667
+ ### Return type
668
+
669
+ **Array<CustomerListAccountDTO>**
670
+
671
+ ### Authorization
672
+
673
+ No authorization required
674
+
675
+ ### HTTP request headers
676
+
677
+ - **Content-Type**: Not defined
678
+ - **Accept**: application/json
679
+
680
+
681
+ ### HTTP response details
682
+ | Status code | Description | Response headers |
683
+ |-------------|-------------|------------------|
684
+ |**200** | Account Addresses | - |
685
+ |**400** | Bad Request | - |
686
+ |**401** | Unauthorised | - |
687
+ |**403** | Access Denied | - |
688
+
689
+ [[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)
690
+
691
+ # **getGetCustomerKeys**
692
+ > Array<TcxKeySummaryDTO> getGetCustomerKeys()
693
+
694
+ Get 3CX Keys
695
+
696
+ ### Example
697
+
698
+ ```typescript
699
+ import {
700
+ AccountsApi,
701
+ Configuration
702
+ } from 'yellowgrid-api-ts';
703
+
704
+ const configuration = new Configuration();
705
+ const apiInstance = new AccountsApi(configuration);
706
+
707
+ const { status, data } = await apiInstance.getGetCustomerKeys();
708
+ ```
709
+
710
+ ### Parameters
711
+ This endpoint does not have any parameters.
712
+
713
+
714
+ ### Return type
715
+
716
+ **Array<TcxKeySummaryDTO>**
717
+
718
+ ### Authorization
719
+
720
+ No authorization required
721
+
722
+ ### HTTP request headers
723
+
724
+ - **Content-Type**: Not defined
725
+ - **Accept**: application/json
726
+
727
+
728
+ ### HTTP response details
729
+ | Status code | Description | Response headers |
730
+ |-------------|-------------|------------------|
731
+ |**200** | 3CX Key Summaries | - |
732
+ |**400** | Bad Request | - |
733
+ |**401** | Unauthorised | - |
734
+ |**403** | Access Denied | - |
735
+
736
+ [[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)
737
+
738
+ # **getGetFinanceSettings**
739
+ > AccountFinanceDTO getGetFinanceSettings()
740
+
741
+ Get Account Finance
742
+
743
+ ### Example
744
+
745
+ ```typescript
746
+ import {
747
+ AccountsApi,
748
+ Configuration
749
+ } from 'yellowgrid-api-ts';
750
+
751
+ const configuration = new Configuration();
752
+ const apiInstance = new AccountsApi(configuration);
753
+
754
+ let id: string; //Account Xero ID (default to undefined)
755
+
756
+ const { status, data } = await apiInstance.getGetFinanceSettings(
757
+ id
758
+ );
759
+ ```
760
+
761
+ ### Parameters
762
+
763
+ |Name | Type | Description | Notes|
764
+ |------------- | ------------- | ------------- | -------------|
765
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
766
+
767
+
768
+ ### Return type
769
+
770
+ **AccountFinanceDTO**
771
+
772
+ ### Authorization
773
+
774
+ No authorization required
775
+
776
+ ### HTTP request headers
777
+
778
+ - **Content-Type**: Not defined
779
+ - **Accept**: application/json
780
+
781
+
782
+ ### HTTP response details
783
+ | Status code | Description | Response headers |
784
+ |-------------|-------------|------------------|
785
+ |**200** | Accounts Finance Details | - |
786
+ |**400** | Bad Request | - |
787
+ |**401** | Unauthorised | - |
788
+ |**403** | Access Denied | - |
789
+
790
+ [[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)
791
+
792
+ # **getGetLastAccount**
793
+ > AccountSummaryDTO getGetLastAccount()
794
+
795
+ Get Last Account
796
+
797
+ ### Example
798
+
799
+ ```typescript
800
+ import {
801
+ AccountsApi,
802
+ Configuration
803
+ } from 'yellowgrid-api-ts';
804
+
805
+ const configuration = new Configuration();
806
+ const apiInstance = new AccountsApi(configuration);
807
+
808
+ const { status, data } = await apiInstance.getGetLastAccount();
809
+ ```
810
+
811
+ ### Parameters
812
+ This endpoint does not have any parameters.
813
+
814
+
815
+ ### Return type
816
+
817
+ **AccountSummaryDTO**
818
+
819
+ ### Authorization
820
+
821
+ No authorization required
822
+
823
+ ### HTTP request headers
824
+
825
+ - **Content-Type**: Not defined
826
+ - **Accept**: application/json
827
+
828
+
829
+ ### HTTP response details
830
+ | Status code | Description | Response headers |
831
+ |-------------|-------------|------------------|
832
+ |**200** | Account Summary | - |
833
+ |**400** | Bad Request | - |
834
+ |**401** | Unauthorised | - |
835
+ |**403** | Access Denied | - |
836
+
837
+ [[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)
838
+
839
+ # **getGetTcxPartnerDetails**
840
+ > PartnerDTO getGetTcxPartnerDetails()
841
+
842
+ Get Account 3CX Details
843
+
844
+ ### Example
845
+
846
+ ```typescript
847
+ import {
848
+ AccountsApi,
849
+ Configuration
850
+ } from 'yellowgrid-api-ts';
851
+
852
+ const configuration = new Configuration();
853
+ const apiInstance = new AccountsApi(configuration);
854
+
855
+ let id: string; //Xero ID (default to undefined)
856
+
857
+ const { status, data } = await apiInstance.getGetTcxPartnerDetails(
858
+ id
859
+ );
860
+ ```
861
+
862
+ ### Parameters
863
+
864
+ |Name | Type | Description | Notes|
865
+ |------------- | ------------- | ------------- | -------------|
866
+ | **id** | [**string**] | Xero ID | defaults to undefined|
867
+
868
+
869
+ ### Return type
870
+
871
+ **PartnerDTO**
872
+
873
+ ### Authorization
874
+
875
+ No authorization required
876
+
877
+ ### HTTP request headers
878
+
879
+ - **Content-Type**: Not defined
880
+ - **Accept**: application/json
881
+
882
+
883
+ ### HTTP response details
884
+ | Status code | Description | Response headers |
885
+ |-------------|-------------|------------------|
886
+ |**200** | Account 3CX Partner Details | - |
887
+ |**400** | Bad Request | - |
888
+ |**401** | Unauthorised | - |
889
+ |**403** | Access Denied | - |
890
+
891
+ [[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)
892
+
893
+ # **getVerifyEmailAddress**
894
+ > getVerifyEmailAddress()
895
+
896
+ Verify account email address
897
+
898
+ ### Example
899
+
900
+ ```typescript
901
+ import {
902
+ AccountsApi,
903
+ Configuration
904
+ } from 'yellowgrid-api-ts';
905
+
906
+ const configuration = new Configuration();
907
+ const apiInstance = new AccountsApi(configuration);
908
+
909
+ let token: string; //Verification Token (default to undefined)
910
+
911
+ const { status, data } = await apiInstance.getVerifyEmailAddress(
912
+ token
913
+ );
914
+ ```
915
+
916
+ ### Parameters
917
+
918
+ |Name | Type | Description | Notes|
919
+ |------------- | ------------- | ------------- | -------------|
920
+ | **token** | [**string**] | Verification Token | defaults to undefined|
921
+
922
+
923
+ ### Return type
924
+
925
+ void (empty response body)
926
+
927
+ ### Authorization
928
+
929
+ No authorization required
930
+
931
+ ### HTTP request headers
932
+
933
+ - **Content-Type**: Not defined
934
+ - **Accept**: Not defined
935
+
936
+
937
+ ### HTTP response details
938
+ | Status code | Description | Response headers |
939
+ |-------------|-------------|------------------|
940
+ |**200** | No Response | - |
941
+ |**400** | Bad Request | - |
942
+ |**401** | Unauthorised | - |
943
+ |**403** | Access Denied | - |
944
+
945
+ [[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)
946
+
947
+ # **patchSetAccountStatus**
948
+ > patchSetAccountStatus()
949
+
950
+ Set Account Statuss
951
+
952
+ ### Example
953
+
954
+ ```typescript
955
+ import {
956
+ AccountsApi,
957
+ Configuration
958
+ } from 'yellowgrid-api-ts';
959
+
960
+ const configuration = new Configuration();
961
+ const apiInstance = new AccountsApi(configuration);
962
+
963
+ let id: string; //Xero ID (default to undefined)
964
+ let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
965
+
966
+ const { status, data } = await apiInstance.patchSetAccountStatus(
967
+ id,
968
+ state
969
+ );
970
+ ```
971
+
972
+ ### Parameters
973
+
974
+ |Name | Type | Description | Notes|
975
+ |------------- | ------------- | ------------- | -------------|
976
+ | **id** | [**string**] | Xero ID | defaults to undefined|
977
+ | **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Portal Access State | defaults to undefined|
978
+
979
+
980
+ ### Return type
981
+
982
+ void (empty response body)
983
+
984
+ ### Authorization
985
+
986
+ No authorization required
987
+
988
+ ### HTTP request headers
989
+
990
+ - **Content-Type**: Not defined
991
+ - **Accept**: Not defined
992
+
993
+
994
+ ### HTTP response details
995
+ | Status code | Description | Response headers |
996
+ |-------------|-------------|------------------|
997
+ |**204** | No Response | - |
998
+ |**400** | Bad Request | - |
999
+ |**401** | Unauthorised | - |
1000
+ |**403** | Access Denied | - |
1001
+
1002
+ [[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)
1003
+
1004
+ # **patchSetPortalAccess**
1005
+ > patchSetPortalAccess()
1006
+
1007
+ Set Account Portal Access
1008
+
1009
+ ### Example
1010
+
1011
+ ```typescript
1012
+ import {
1013
+ AccountsApi,
1014
+ Configuration
1015
+ } from 'yellowgrid-api-ts';
1016
+
1017
+ const configuration = new Configuration();
1018
+ const apiInstance = new AccountsApi(configuration);
1019
+
1020
+ let id: string; //Xero ID (default to undefined)
1021
+ let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
1022
+
1023
+ const { status, data } = await apiInstance.patchSetPortalAccess(
1024
+ id,
1025
+ state
1026
+ );
1027
+ ```
1028
+
1029
+ ### Parameters
1030
+
1031
+ |Name | Type | Description | Notes|
1032
+ |------------- | ------------- | ------------- | -------------|
1033
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1034
+ | **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Portal Access State | defaults to undefined|
1035
+
1036
+
1037
+ ### Return type
1038
+
1039
+ void (empty response body)
1040
+
1041
+ ### Authorization
1042
+
1043
+ No authorization required
1044
+
1045
+ ### HTTP request headers
1046
+
1047
+ - **Content-Type**: Not defined
1048
+ - **Accept**: Not defined
1049
+
1050
+
1051
+ ### HTTP response details
1052
+ | Status code | Description | Response headers |
1053
+ |-------------|-------------|------------------|
1054
+ |**204** | No Response | - |
1055
+ |**400** | Bad Request | - |
1056
+ |**401** | Unauthorised | - |
1057
+ |**403** | Access Denied | - |
1058
+
1059
+ [[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)
1060
+
1061
+ # **patchSetPrizePromo**
1062
+ > patchSetPrizePromo()
1063
+
1064
+ Set Account Prize Promo
1065
+
1066
+ ### Example
1067
+
1068
+ ```typescript
1069
+ import {
1070
+ AccountsApi,
1071
+ Configuration
1072
+ } from 'yellowgrid-api-ts';
1073
+
1074
+ const configuration = new Configuration();
1075
+ const apiInstance = new AccountsApi(configuration);
1076
+
1077
+ let id: string; //Xero ID (default to undefined)
1078
+ let state: 'enable' | 'disable'; //Prize Promo State (default to undefined)
1079
+
1080
+ const { status, data } = await apiInstance.patchSetPrizePromo(
1081
+ id,
1082
+ state
1083
+ );
1084
+ ```
1085
+
1086
+ ### Parameters
1087
+
1088
+ |Name | Type | Description | Notes|
1089
+ |------------- | ------------- | ------------- | -------------|
1090
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1091
+ | **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Prize Promo State | defaults to undefined|
1092
+
1093
+
1094
+ ### Return type
1095
+
1096
+ void (empty response body)
1097
+
1098
+ ### Authorization
1099
+
1100
+ No authorization required
1101
+
1102
+ ### HTTP request headers
1103
+
1104
+ - **Content-Type**: Not defined
1105
+ - **Accept**: Not defined
1106
+
1107
+
1108
+ ### HTTP response details
1109
+ | Status code | Description | Response headers |
1110
+ |-------------|-------------|------------------|
1111
+ |**204** | No Response | - |
1112
+ |**400** | Bad Request | - |
1113
+ |**401** | Unauthorised | - |
1114
+ |**403** | Access Denied | - |
1115
+
1116
+ [[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)
1117
+
1118
+ # **patchSetTcxWizardCname**
1119
+ > patchSetTcxWizardCname()
1120
+
1121
+ Set 3CX Wizard CNAME
1122
+
1123
+ ### Example
1124
+
1125
+ ```typescript
1126
+ import {
1127
+ AccountsApi,
1128
+ Configuration,
1129
+ PatchUpdateAccountCnameRequest
1130
+ } from 'yellowgrid-api-ts';
1131
+
1132
+ const configuration = new Configuration();
1133
+ const apiInstance = new AccountsApi(configuration);
1134
+
1135
+ let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
1136
+
1137
+ const { status, data } = await apiInstance.patchSetTcxWizardCname(
1138
+ patchUpdateAccountCnameRequest
1139
+ );
1140
+ ```
1141
+
1142
+ ### Parameters
1143
+
1144
+ |Name | Type | Description | Notes|
1145
+ |------------- | ------------- | ------------- | -------------|
1146
+ | **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
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
+ |**200** | 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
+ # **patchUpdateAccountCname**
1174
+ > patchUpdateAccountCname()
1175
+
1176
+ Set Account CNAME
1177
+
1178
+ ### Example
1179
+
1180
+ ```typescript
1181
+ import {
1182
+ AccountsApi,
1183
+ Configuration,
1184
+ PatchUpdateAccountCnameRequest
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 patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
1192
+
1193
+ const { status, data } = await apiInstance.patchUpdateAccountCname(
1194
+ id,
1195
+ patchUpdateAccountCnameRequest
1196
+ );
1197
+ ```
1198
+
1199
+ ### Parameters
1200
+
1201
+ |Name | Type | Description | Notes|
1202
+ |------------- | ------------- | ------------- | -------------|
1203
+ | **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME 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
+ # **patchUpdateAccountCompanyNumber**
1232
+ > patchUpdateAccountCompanyNumber()
1233
+
1234
+ Set Account Company Number
1235
+
1236
+ ### Example
1237
+
1238
+ ```typescript
1239
+ import {
1240
+ AccountsApi,
1241
+ Configuration,
1242
+ PatchUpdateAccountCompanyNumberRequest
1243
+ } from 'yellowgrid-api-ts';
1244
+
1245
+ const configuration = new Configuration();
1246
+ const apiInstance = new AccountsApi(configuration);
1247
+
1248
+ let id: string; //Xero ID (default to undefined)
1249
+ let patchUpdateAccountCompanyNumberRequest: PatchUpdateAccountCompanyNumberRequest; //Account Company Number Request (optional)
1250
+
1251
+ const { status, data } = await apiInstance.patchUpdateAccountCompanyNumber(
1252
+ id,
1253
+ patchUpdateAccountCompanyNumberRequest
1254
+ );
1255
+ ```
1256
+
1257
+ ### Parameters
1258
+
1259
+ |Name | Type | Description | Notes|
1260
+ |------------- | ------------- | ------------- | -------------|
1261
+ | **patchUpdateAccountCompanyNumberRequest** | **PatchUpdateAccountCompanyNumberRequest**| Account Company Number Request | |
1262
+ | **id** | [**string**] | Xero ID | 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
+ |**204** | 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
+ # **patchUpdateAccountContactPassword**
1290
+ > patchUpdateAccountContactPassword()
1291
+
1292
+ Update Account Password
1293
+
1294
+ ### Example
1295
+
1296
+ ```typescript
1297
+ import {
1298
+ AccountsApi,
1299
+ Configuration,
1300
+ PatchUpdateAccountContactPasswordRequest
1301
+ } from 'yellowgrid-api-ts';
1302
+
1303
+ const configuration = new Configuration();
1304
+ const apiInstance = new AccountsApi(configuration);
1305
+
1306
+ let token: string; //Verification Token (default to undefined)
1307
+ let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
1308
+
1309
+ const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
1310
+ token,
1311
+ patchUpdateAccountContactPasswordRequest
1312
+ );
1313
+ ```
1314
+
1315
+ ### Parameters
1316
+
1317
+ |Name | Type | Description | Notes|
1318
+ |------------- | ------------- | ------------- | -------------|
1319
+ | **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
1320
+ | **token** | [**string**] | Verification Token | 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
+ |**200** | 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
+ # **patchUpdateAccountPhone**
1348
+ > patchUpdateAccountPhone()
1349
+
1350
+ Set Account Phone
1351
+
1352
+ ### Example
1353
+
1354
+ ```typescript
1355
+ import {
1356
+ AccountsApi,
1357
+ Configuration,
1358
+ PatchUpdateAccountPhoneRequest
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 patchUpdateAccountPhoneRequest: PatchUpdateAccountPhoneRequest; //Telephone Request (optional)
1366
+
1367
+ const { status, data } = await apiInstance.patchUpdateAccountPhone(
1368
+ id,
1369
+ patchUpdateAccountPhoneRequest
1370
+ );
1371
+ ```
1372
+
1373
+ ### Parameters
1374
+
1375
+ |Name | Type | Description | Notes|
1376
+ |------------- | ------------- | ------------- | -------------|
1377
+ | **patchUpdateAccountPhoneRequest** | **PatchUpdateAccountPhoneRequest**| Telephone 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
+ # **patchUpdateAccountVatNumber**
1406
+ > patchUpdateAccountVatNumber()
1407
+
1408
+ Set Account VAT Number
1409
+
1410
+ ### Example
1411
+
1412
+ ```typescript
1413
+ import {
1414
+ AccountsApi,
1415
+ Configuration,
1416
+ PatchUpdateAccountVatNumberRequest
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 patchUpdateAccountVatNumberRequest: PatchUpdateAccountVatNumberRequest; //VAT Number Request (optional)
1424
+
1425
+ const { status, data } = await apiInstance.patchUpdateAccountVatNumber(
1426
+ id,
1427
+ patchUpdateAccountVatNumberRequest
1428
+ );
1429
+ ```
1430
+
1431
+ ### Parameters
1432
+
1433
+ |Name | Type | Description | Notes|
1434
+ |------------- | ------------- | ------------- | -------------|
1435
+ | **patchUpdateAccountVatNumberRequest** | **PatchUpdateAccountVatNumberRequest**| VAT Number Request | |
1436
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1437
+
1438
+
1439
+ ### Return type
1440
+
1441
+ void (empty response body)
1442
+
1443
+ ### Authorization
1444
+
1445
+ No authorization required
1446
+
1447
+ ### HTTP request headers
1448
+
1449
+ - **Content-Type**: application/json
1450
+ - **Accept**: Not defined
1451
+
1452
+
1453
+ ### HTTP response details
1454
+ | Status code | Description | Response headers |
1455
+ |-------------|-------------|------------------|
1456
+ |**204** | No Response | - |
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
+ # **patchUpdateCreditLimit**
1464
+ > AccountFinanceDTO patchUpdateCreditLimit()
1465
+
1466
+ Set Account Credit Limit
1467
+
1468
+ ### Example
1469
+
1470
+ ```typescript
1471
+ import {
1472
+ AccountsApi,
1473
+ Configuration,
1474
+ PatchUpdateCreditLimitRequest
1475
+ } from 'yellowgrid-api-ts';
1476
+
1477
+ const configuration = new Configuration();
1478
+ const apiInstance = new AccountsApi(configuration);
1479
+
1480
+ let id: string; //Xero ID (default to undefined)
1481
+ let patchUpdateCreditLimitRequest: PatchUpdateCreditLimitRequest; //Credit Limit Request (optional)
1482
+
1483
+ const { status, data } = await apiInstance.patchUpdateCreditLimit(
1484
+ id,
1485
+ patchUpdateCreditLimitRequest
1486
+ );
1487
+ ```
1488
+
1489
+ ### Parameters
1490
+
1491
+ |Name | Type | Description | Notes|
1492
+ |------------- | ------------- | ------------- | -------------|
1493
+ | **patchUpdateCreditLimitRequest** | **PatchUpdateCreditLimitRequest**| Credit Limit Request | |
1494
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1495
+
1496
+
1497
+ ### Return type
1498
+
1499
+ **AccountFinanceDTO**
1500
+
1501
+ ### Authorization
1502
+
1503
+ No authorization required
1504
+
1505
+ ### HTTP request headers
1506
+
1507
+ - **Content-Type**: application/json
1508
+ - **Accept**: application/json
1509
+
1510
+
1511
+ ### HTTP response details
1512
+ | Status code | Description | Response headers |
1513
+ |-------------|-------------|------------------|
1514
+ |**200** | Accounts Finance Details | - |
1515
+ |**400** | Bad Request | - |
1516
+ |**401** | Unauthorised | - |
1517
+ |**403** | Access Denied | - |
1518
+
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)
1520
+
1521
+ # **patchUpdatePriceList**
1522
+ > AccountFinanceDTO patchUpdatePriceList()
355
1523
 
356
- Get user\'s client credentials
1524
+ Set Account Price List
357
1525
 
358
1526
  ### Example
359
1527
 
360
1528
  ```typescript
361
1529
  import {
362
1530
  AccountsApi,
363
- Configuration
1531
+ Configuration,
1532
+ PatchUpdatePriceListRequest
364
1533
  } from 'yellowgrid-api-ts';
365
1534
 
366
1535
  const configuration = new Configuration();
367
1536
  const apiInstance = new AccountsApi(configuration);
368
1537
 
369
- const { status, data } = await apiInstance.getGetClientCredentials();
1538
+ let id: string; //Xero ID (default to undefined)
1539
+ let patchUpdatePriceListRequest: PatchUpdatePriceListRequest; //Price List Request (optional)
1540
+
1541
+ const { status, data } = await apiInstance.patchUpdatePriceList(
1542
+ id,
1543
+ patchUpdatePriceListRequest
1544
+ );
370
1545
  ```
371
1546
 
372
1547
  ### Parameters
373
- This endpoint does not have any parameters.
1548
+
1549
+ |Name | Type | Description | Notes|
1550
+ |------------- | ------------- | ------------- | -------------|
1551
+ | **patchUpdatePriceListRequest** | **PatchUpdatePriceListRequest**| Price List Request | |
1552
+ | **id** | [**string**] | Xero ID | defaults to undefined|
374
1553
 
375
1554
 
376
1555
  ### Return type
377
1556
 
378
- **Array<ClientModel>**
1557
+ **AccountFinanceDTO**
379
1558
 
380
1559
  ### Authorization
381
1560
 
@@ -383,46 +1562,57 @@ No authorization required
383
1562
 
384
1563
  ### HTTP request headers
385
1564
 
386
- - **Content-Type**: Not defined
1565
+ - **Content-Type**: application/json
387
1566
  - **Accept**: application/json
388
1567
 
389
1568
 
390
1569
  ### HTTP response details
391
1570
  | Status code | Description | Response headers |
392
1571
  |-------------|-------------|------------------|
393
- |**200** | List of client credentials | - |
1572
+ |**200** | Accounts Finance Details | - |
394
1573
  |**400** | Bad Request | - |
395
1574
  |**401** | Unauthorised | - |
396
1575
  |**403** | Access Denied | - |
397
1576
 
398
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)
399
1578
 
400
- # **getGetCustomerKeys**
401
- > Array<TcxKeySummaryDTO> getGetCustomerKeys()
1579
+ # **patchUpdateSipChannelCost**
1580
+ > AccountFinanceDTO patchUpdateSipChannelCost()
402
1581
 
403
- Get 3CX Keys
1582
+ Set Account SIP Channel Cost
404
1583
 
405
1584
  ### Example
406
1585
 
407
1586
  ```typescript
408
1587
  import {
409
1588
  AccountsApi,
410
- Configuration
1589
+ Configuration,
1590
+ PatchUpdateSipChannelCostRequest
411
1591
  } from 'yellowgrid-api-ts';
412
1592
 
413
1593
  const configuration = new Configuration();
414
1594
  const apiInstance = new AccountsApi(configuration);
415
1595
 
416
- const { status, data } = await apiInstance.getGetCustomerKeys();
1596
+ let id: string; //Xero ID (default to undefined)
1597
+ let patchUpdateSipChannelCostRequest: PatchUpdateSipChannelCostRequest; //SIP Channel Cost Request (optional)
1598
+
1599
+ const { status, data } = await apiInstance.patchUpdateSipChannelCost(
1600
+ id,
1601
+ patchUpdateSipChannelCostRequest
1602
+ );
417
1603
  ```
418
1604
 
419
1605
  ### Parameters
420
- This endpoint does not have any parameters.
1606
+
1607
+ |Name | Type | Description | Notes|
1608
+ |------------- | ------------- | ------------- | -------------|
1609
+ | **patchUpdateSipChannelCostRequest** | **PatchUpdateSipChannelCostRequest**| SIP Channel Cost Request | |
1610
+ | **id** | [**string**] | Xero ID | defaults to undefined|
421
1611
 
422
1612
 
423
1613
  ### Return type
424
1614
 
425
- **Array<TcxKeySummaryDTO>**
1615
+ **AccountFinanceDTO**
426
1616
 
427
1617
  ### Authorization
428
1618
 
@@ -430,40 +1620,43 @@ No authorization required
430
1620
 
431
1621
  ### HTTP request headers
432
1622
 
433
- - **Content-Type**: Not defined
1623
+ - **Content-Type**: application/json
434
1624
  - **Accept**: application/json
435
1625
 
436
1626
 
437
1627
  ### HTTP response details
438
1628
  | Status code | Description | Response headers |
439
1629
  |-------------|-------------|------------------|
440
- |**200** | 3CX Key Summaries | - |
1630
+ |**200** | Accounts Finance Details | - |
441
1631
  |**400** | Bad Request | - |
442
1632
  |**401** | Unauthorised | - |
443
1633
  |**403** | Access Denied | - |
444
1634
 
445
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)
446
1636
 
447
- # **getVerifyEmailAddress**
448
- > getVerifyEmailAddress()
1637
+ # **patchUpdateTcxHostingPriceList**
1638
+ > PartnerDTO patchUpdateTcxHostingPriceList()
449
1639
 
450
- Verify account email address
1640
+ Set Account 3CX Hosting Price List
451
1641
 
452
1642
  ### Example
453
1643
 
454
1644
  ```typescript
455
1645
  import {
456
1646
  AccountsApi,
457
- Configuration
1647
+ Configuration,
1648
+ PatchUpdateTcxHostingPriceListRequest
458
1649
  } from 'yellowgrid-api-ts';
459
1650
 
460
1651
  const configuration = new Configuration();
461
1652
  const apiInstance = new AccountsApi(configuration);
462
1653
 
463
- let token: string; //Verification Token (default to undefined)
1654
+ let id: string; //Xero ID (default to undefined)
1655
+ let patchUpdateTcxHostingPriceListRequest: PatchUpdateTcxHostingPriceListRequest; //3CX Hosting Price List Request (optional)
464
1656
 
465
- const { status, data } = await apiInstance.getVerifyEmailAddress(
466
- token
1657
+ const { status, data } = await apiInstance.patchUpdateTcxHostingPriceList(
1658
+ id,
1659
+ patchUpdateTcxHostingPriceListRequest
467
1660
  );
468
1661
  ```
469
1662
 
@@ -471,12 +1664,13 @@ const { status, data } = await apiInstance.getVerifyEmailAddress(
471
1664
 
472
1665
  |Name | Type | Description | Notes|
473
1666
  |------------- | ------------- | ------------- | -------------|
474
- | **token** | [**string**] | Verification Token | defaults to undefined|
1667
+ | **patchUpdateTcxHostingPriceListRequest** | **PatchUpdateTcxHostingPriceListRequest**| 3CX Hosting Price List Request | |
1668
+ | **id** | [**string**] | Xero ID | defaults to undefined|
475
1669
 
476
1670
 
477
1671
  ### Return type
478
1672
 
479
- void (empty response body)
1673
+ **PartnerDTO**
480
1674
 
481
1675
  ### Authorization
482
1676
 
@@ -484,24 +1678,24 @@ No authorization required
484
1678
 
485
1679
  ### HTTP request headers
486
1680
 
487
- - **Content-Type**: Not defined
488
- - **Accept**: Not defined
1681
+ - **Content-Type**: application/json
1682
+ - **Accept**: application/json
489
1683
 
490
1684
 
491
1685
  ### HTTP response details
492
1686
  | Status code | Description | Response headers |
493
1687
  |-------------|-------------|------------------|
494
- |**200** | No Response | - |
1688
+ |**200** | Account 3CX Partner Details | - |
495
1689
  |**400** | Bad Request | - |
496
1690
  |**401** | Unauthorised | - |
497
1691
  |**403** | Access Denied | - |
498
1692
 
499
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)
500
1694
 
501
- # **patchSetTcxWizardCname**
502
- > patchSetTcxWizardCname()
1695
+ # **patchUpdateTcxPartnerId**
1696
+ > PartnerDTO patchUpdateTcxPartnerId()
503
1697
 
504
- Set 3CX Wizard CNAME
1698
+ Set Account 3CX Partner ID
505
1699
 
506
1700
  ### Example
507
1701
 
@@ -509,16 +1703,18 @@ Set 3CX Wizard CNAME
509
1703
  import {
510
1704
  AccountsApi,
511
1705
  Configuration,
512
- PatchSetTcxWizardCnameRequest
1706
+ PatchUpdateTcxPartnerIdRequest
513
1707
  } from 'yellowgrid-api-ts';
514
1708
 
515
1709
  const configuration = new Configuration();
516
1710
  const apiInstance = new AccountsApi(configuration);
517
1711
 
518
- let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
1712
+ let id: string; //Xero ID (default to undefined)
1713
+ let patchUpdateTcxPartnerIdRequest: PatchUpdateTcxPartnerIdRequest; //Set Account 3CX Partner ID (optional)
519
1714
 
520
- const { status, data } = await apiInstance.patchSetTcxWizardCname(
521
- patchSetTcxWizardCnameRequest
1715
+ const { status, data } = await apiInstance.patchUpdateTcxPartnerId(
1716
+ id,
1717
+ patchUpdateTcxPartnerIdRequest
522
1718
  );
523
1719
  ```
524
1720
 
@@ -526,12 +1722,13 @@ const { status, data } = await apiInstance.patchSetTcxWizardCname(
526
1722
 
527
1723
  |Name | Type | Description | Notes|
528
1724
  |------------- | ------------- | ------------- | -------------|
529
- | **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
1725
+ | **patchUpdateTcxPartnerIdRequest** | **PatchUpdateTcxPartnerIdRequest**| Set Account 3CX Partner ID | |
1726
+ | **id** | [**string**] | Xero ID | defaults to undefined|
530
1727
 
531
1728
 
532
1729
  ### Return type
533
1730
 
534
- void (empty response body)
1731
+ **PartnerDTO**
535
1732
 
536
1733
  ### Authorization
537
1734
 
@@ -540,23 +1737,23 @@ No authorization required
540
1737
  ### HTTP request headers
541
1738
 
542
1739
  - **Content-Type**: application/json
543
- - **Accept**: Not defined
1740
+ - **Accept**: application/json
544
1741
 
545
1742
 
546
1743
  ### HTTP response details
547
1744
  | Status code | Description | Response headers |
548
1745
  |-------------|-------------|------------------|
549
- |**200** | No Response | - |
1746
+ |**200** | Account 3CX Partner Details | - |
550
1747
  |**400** | Bad Request | - |
551
1748
  |**401** | Unauthorised | - |
552
1749
  |**403** | Access Denied | - |
553
1750
 
554
1751
  [[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
1752
 
556
- # **patchUpdateAccountContactPassword**
557
- > patchUpdateAccountContactPassword()
1753
+ # **postAdminCreateAccountContact**
1754
+ > postAdminCreateAccountContact()
558
1755
 
559
- Update Account Password
1756
+ Create Account Contact
560
1757
 
561
1758
  ### Example
562
1759
 
@@ -564,18 +1761,18 @@ Update Account Password
564
1761
  import {
565
1762
  AccountsApi,
566
1763
  Configuration,
567
- PatchUpdateAccountContactPasswordRequest
1764
+ AccountContactRequestModel
568
1765
  } from 'yellowgrid-api-ts';
569
1766
 
570
1767
  const configuration = new Configuration();
571
1768
  const apiInstance = new AccountsApi(configuration);
572
1769
 
573
- let token: string; //Verification Token (default to undefined)
574
- let patchUpdateAccountContactPasswordRequest: PatchUpdateAccountContactPasswordRequest; //New account request (optional)
1770
+ let id: string; //Account Xero ID (default to undefined)
1771
+ let accountContactRequestModel: AccountContactRequestModel; //Create Account Contact Request (optional)
575
1772
 
576
- const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
577
- token,
578
- patchUpdateAccountContactPasswordRequest
1773
+ const { status, data } = await apiInstance.postAdminCreateAccountContact(
1774
+ id,
1775
+ accountContactRequestModel
579
1776
  );
580
1777
  ```
581
1778
 
@@ -583,8 +1780,8 @@ const { status, data } = await apiInstance.patchUpdateAccountContactPassword(
583
1780
 
584
1781
  |Name | Type | Description | Notes|
585
1782
  |------------- | ------------- | ------------- | -------------|
586
- | **patchUpdateAccountContactPasswordRequest** | **PatchUpdateAccountContactPasswordRequest**| New account request | |
587
- | **token** | [**string**] | Verification Token | defaults to undefined|
1783
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Create Account Contact Request | |
1784
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
588
1785
 
589
1786
 
590
1787
  ### Return type
@@ -604,7 +1801,7 @@ No authorization required
604
1801
  ### HTTP response details
605
1802
  | Status code | Description | Response headers |
606
1803
  |-------------|-------------|------------------|
607
- |**200** | No Response | - |
1804
+ |**201** | No Response | - |
608
1805
  |**400** | Bad Request | - |
609
1806
  |**401** | Unauthorised | - |
610
1807
  |**403** | Access Denied | - |
@@ -921,6 +2118,64 @@ No authorization required
921
2118
  - **Accept**: Not defined
922
2119
 
923
2120
 
2121
+ ### HTTP response details
2122
+ | Status code | Description | Response headers |
2123
+ |-------------|-------------|------------------|
2124
+ |**200** | No Response | - |
2125
+ |**400** | Bad Request | - |
2126
+ |**401** | Unauthorised | - |
2127
+ |**403** | Access Denied | - |
2128
+
2129
+ [[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)
2130
+
2131
+ # **postSendWelcomeEmail**
2132
+ > postSendWelcomeEmail()
2133
+
2134
+ Send Account Welcome Email
2135
+
2136
+ ### Example
2137
+
2138
+ ```typescript
2139
+ import {
2140
+ AccountsApi,
2141
+ Configuration,
2142
+ PostSendWelcomeEmailRequest
2143
+ } from 'yellowgrid-api-ts';
2144
+
2145
+ const configuration = new Configuration();
2146
+ const apiInstance = new AccountsApi(configuration);
2147
+
2148
+ let id: string; //Xero ID (default to undefined)
2149
+ let postSendWelcomeEmailRequest: PostSendWelcomeEmailRequest; //Email Request (optional)
2150
+
2151
+ const { status, data } = await apiInstance.postSendWelcomeEmail(
2152
+ id,
2153
+ postSendWelcomeEmailRequest
2154
+ );
2155
+ ```
2156
+
2157
+ ### Parameters
2158
+
2159
+ |Name | Type | Description | Notes|
2160
+ |------------- | ------------- | ------------- | -------------|
2161
+ | **postSendWelcomeEmailRequest** | **PostSendWelcomeEmailRequest**| Email Request | |
2162
+ | **id** | [**string**] | Xero ID | defaults to undefined|
2163
+
2164
+
2165
+ ### Return type
2166
+
2167
+ void (empty response body)
2168
+
2169
+ ### Authorization
2170
+
2171
+ No authorization required
2172
+
2173
+ ### HTTP request headers
2174
+
2175
+ - **Content-Type**: application/json
2176
+ - **Accept**: Not defined
2177
+
2178
+
924
2179
  ### HTTP response details
925
2180
  | Status code | Description | Response headers |
926
2181
  |-------------|-------------|------------------|
@@ -991,6 +2246,67 @@ No authorization required
991
2246
 
992
2247
  [[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
2248
 
2249
+ # **putAdminUpdateAccountContact**
2250
+ > putAdminUpdateAccountContact()
2251
+
2252
+ Update Account Contact
2253
+
2254
+ ### Example
2255
+
2256
+ ```typescript
2257
+ import {
2258
+ AccountsApi,
2259
+ Configuration,
2260
+ AccountContactRequestModel
2261
+ } from 'yellowgrid-api-ts';
2262
+
2263
+ const configuration = new Configuration();
2264
+ const apiInstance = new AccountsApi(configuration);
2265
+
2266
+ let id: string; //Account Xero ID (default to undefined)
2267
+ let contactId: number; //Contact ID (default to undefined)
2268
+ let accountContactRequestModel: AccountContactRequestModel; //Update Account Contact Request (optional)
2269
+
2270
+ const { status, data } = await apiInstance.putAdminUpdateAccountContact(
2271
+ id,
2272
+ contactId,
2273
+ accountContactRequestModel
2274
+ );
2275
+ ```
2276
+
2277
+ ### Parameters
2278
+
2279
+ |Name | Type | Description | Notes|
2280
+ |------------- | ------------- | ------------- | -------------|
2281
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
2282
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
2283
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
2284
+
2285
+
2286
+ ### Return type
2287
+
2288
+ void (empty response body)
2289
+
2290
+ ### Authorization
2291
+
2292
+ No authorization required
2293
+
2294
+ ### HTTP request headers
2295
+
2296
+ - **Content-Type**: application/json
2297
+ - **Accept**: Not defined
2298
+
2299
+
2300
+ ### HTTP response details
2301
+ | Status code | Description | Response headers |
2302
+ |-------------|-------------|------------------|
2303
+ |**204** | No Response | - |
2304
+ |**400** | Bad Request | - |
2305
+ |**401** | Unauthorised | - |
2306
+ |**403** | Access Denied | - |
2307
+
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)
2309
+
994
2310
  # **putUpdateAccountContact**
995
2311
  > putUpdateAccountContact()
996
2312
 
@@ -1049,3 +2365,119 @@ No authorization required
1049
2365
 
1050
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)
1051
2367
 
2368
+ # **putUpdateBillingAddress**
2369
+ > putUpdateBillingAddress()
2370
+
2371
+ Update Account Billing 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 Billing Address (optional)
2387
+
2388
+ const { status, data } = await apiInstance.putUpdateBillingAddress(
2389
+ id,
2390
+ addressDTO
2391
+ );
2392
+ ```
2393
+
2394
+ ### Parameters
2395
+
2396
+ |Name | Type | Description | Notes|
2397
+ |------------- | ------------- | ------------- | -------------|
2398
+ | **addressDTO** | **AddressDTO**| Updated Billing 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
+
2426
+ # **putUpdateShippingAddress**
2427
+ > putUpdateShippingAddress()
2428
+
2429
+ Update Account Shipping Address
2430
+
2431
+ ### Example
2432
+
2433
+ ```typescript
2434
+ import {
2435
+ AccountsApi,
2436
+ Configuration,
2437
+ AddressDTO
2438
+ } from 'yellowgrid-api-ts';
2439
+
2440
+ const configuration = new Configuration();
2441
+ const apiInstance = new AccountsApi(configuration);
2442
+
2443
+ let id: string; //Xero ID (default to undefined)
2444
+ let addressDTO: AddressDTO; //Updated Shipping Address (optional)
2445
+
2446
+ const { status, data } = await apiInstance.putUpdateShippingAddress(
2447
+ id,
2448
+ addressDTO
2449
+ );
2450
+ ```
2451
+
2452
+ ### Parameters
2453
+
2454
+ |Name | Type | Description | Notes|
2455
+ |------------- | ------------- | ------------- | -------------|
2456
+ | **addressDTO** | **AddressDTO**| Updated Shipping Address | |
2457
+ | **id** | [**string**] | Xero ID | defaults to undefined|
2458
+
2459
+
2460
+ ### Return type
2461
+
2462
+ void (empty response body)
2463
+
2464
+ ### Authorization
2465
+
2466
+ No authorization required
2467
+
2468
+ ### HTTP request headers
2469
+
2470
+ - **Content-Type**: application/json
2471
+ - **Accept**: Not defined
2472
+
2473
+
2474
+ ### HTTP response details
2475
+ | Status code | Description | Response headers |
2476
+ |-------------|-------------|------------------|
2477
+ |**204** | No Response | - |
2478
+ |**400** | Bad Request | - |
2479
+ |**401** | Unauthorised | - |
2480
+ |**403** | Access Denied | - |
2481
+
2482
+ [[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)
2483
+