yellowgrid-api-ts 3.2.135-dev.0 → 3.2.137-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,9 +4,10 @@ All URIs are relative to *https://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**deleteAdminUpdateAccountContact**](#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} | |
7
8
  |[**deleteDeleteClientCredentials**](#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials|
8
9
  |[**deleteUpdateAccountContact**](#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact|
9
- |[**deleteUpdateContact**](#deleteupdatecontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} | |
10
+ |[**getAdminCreateAccountContact**](#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts/ | |
10
11
  |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
11
12
  |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
12
13
  |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
@@ -23,7 +24,7 @@ All URIs are relative to *https://localhost*
23
24
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
24
25
  |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
25
26
  |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
26
- |[**postCreateContact**](#postcreatecontact) | **POST** /admin/accounts/{id}/contacts/ | |
27
+ |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts/ | |
27
28
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
28
29
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
29
30
  |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
@@ -32,11 +33,68 @@ All URIs are relative to *https://localhost*
32
33
  |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
33
34
  |[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
34
35
  |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
36
+ |[**putAdminUpdateAccountContact**](#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
35
37
  |[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
36
38
  |[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
37
- |[**putUpdateContact**](#putupdatecontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
38
39
  |[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
39
40
 
41
+ # **deleteAdminUpdateAccountContact**
42
+ > deleteAdminUpdateAccountContact()
43
+
44
+ Delete Account Contact
45
+
46
+ ### Example
47
+
48
+ ```typescript
49
+ import {
50
+ AccountsApi,
51
+ Configuration
52
+ } from 'yellowgrid-api-ts';
53
+
54
+ const configuration = new Configuration();
55
+ const apiInstance = new AccountsApi(configuration);
56
+
57
+ let id: string; //Account Xero ID (default to undefined)
58
+ let contactId: number; //Contact ID (default to undefined)
59
+
60
+ const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
61
+ id,
62
+ contactId
63
+ );
64
+ ```
65
+
66
+ ### Parameters
67
+
68
+ |Name | Type | Description | Notes|
69
+ |------------- | ------------- | ------------- | -------------|
70
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
71
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
72
+
73
+
74
+ ### Return type
75
+
76
+ void (empty response body)
77
+
78
+ ### Authorization
79
+
80
+ No authorization required
81
+
82
+ ### HTTP request headers
83
+
84
+ - **Content-Type**: Not defined
85
+ - **Accept**: Not defined
86
+
87
+
88
+ ### HTTP response details
89
+ | Status code | Description | Response headers |
90
+ |-------------|-------------|------------------|
91
+ |**204** | No Response | - |
92
+ |**400** | Bad Request | - |
93
+ |**401** | Unauthorised | - |
94
+ |**403** | Access Denied | - |
95
+
96
+ [[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)
97
+
40
98
  # **deleteDeleteClientCredentials**
41
99
  > deleteDeleteClientCredentials()
42
100
 
@@ -145,10 +203,10 @@ No authorization required
145
203
 
146
204
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
147
205
 
148
- # **deleteUpdateContact**
149
- > deleteUpdateContact()
206
+ # **getAdminCreateAccountContact**
207
+ > Array<AccountContactModel> getAdminCreateAccountContact()
150
208
 
151
- Delete Account Contact
209
+ Get Account Contacts
152
210
 
153
211
  ### Example
154
212
 
@@ -162,11 +220,9 @@ const configuration = new Configuration();
162
220
  const apiInstance = new AccountsApi(configuration);
163
221
 
164
222
  let id: string; //Account Xero ID (default to undefined)
165
- let contactId: number; //Contact ID (default to undefined)
166
223
 
167
- const { status, data } = await apiInstance.deleteUpdateContact(
168
- id,
169
- contactId
224
+ const { status, data } = await apiInstance.getAdminCreateAccountContact(
225
+ id
170
226
  );
171
227
  ```
172
228
 
@@ -175,12 +231,11 @@ const { status, data } = await apiInstance.deleteUpdateContact(
175
231
  |Name | Type | Description | Notes|
176
232
  |------------- | ------------- | ------------- | -------------|
177
233
  | **id** | [**string**] | Account Xero ID | defaults to undefined|
178
- | **contactId** | [**number**] | Contact ID | defaults to undefined|
179
234
 
180
235
 
181
236
  ### Return type
182
237
 
183
- void (empty response body)
238
+ **Array<AccountContactModel>**
184
239
 
185
240
  ### Authorization
186
241
 
@@ -189,13 +244,13 @@ No authorization required
189
244
  ### HTTP request headers
190
245
 
191
246
  - **Content-Type**: Not defined
192
- - **Accept**: Not defined
247
+ - **Accept**: application/json
193
248
 
194
249
 
195
250
  ### HTTP response details
196
251
  | Status code | Description | Response headers |
197
252
  |-------------|-------------|------------------|
198
- |**204** | No Response | - |
253
+ |**200** | Account | - |
199
254
  |**400** | Bad Request | - |
200
255
  |**401** | Unauthorised | - |
201
256
  |**403** | Access Denied | - |
@@ -1081,8 +1136,8 @@ No authorization required
1081
1136
 
1082
1137
  [[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)
1083
1138
 
1084
- # **postCreateContact**
1085
- > postCreateContact()
1139
+ # **postAdminCreateAccountContact**
1140
+ > postAdminCreateAccountContact()
1086
1141
 
1087
1142
  Create Account Contact
1088
1143
 
@@ -1101,7 +1156,7 @@ const apiInstance = new AccountsApi(configuration);
1101
1156
  let id: string; //Account Xero ID (default to undefined)
1102
1157
  let accountContactRequestModel: AccountContactRequestModel; //Create Account Contact Request (optional)
1103
1158
 
1104
- const { status, data } = await apiInstance.postCreateContact(
1159
+ const { status, data } = await apiInstance.postAdminCreateAccountContact(
1105
1160
  id,
1106
1161
  accountContactRequestModel
1107
1162
  );
@@ -1577,10 +1632,10 @@ No authorization required
1577
1632
 
1578
1633
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1579
1634
 
1580
- # **putUpdateAccountContact**
1581
- > putUpdateAccountContact()
1635
+ # **putAdminUpdateAccountContact**
1636
+ > putAdminUpdateAccountContact()
1582
1637
 
1583
- Update Account Contacts
1638
+ Update Account Contact
1584
1639
 
1585
1640
  ### Example
1586
1641
 
@@ -1594,11 +1649,13 @@ import {
1594
1649
  const configuration = new Configuration();
1595
1650
  const apiInstance = new AccountsApi(configuration);
1596
1651
 
1597
- let email: string; //Contact Email Address (default to undefined)
1598
- let accountContactRequestModel: AccountContactRequestModel; //Account request (optional)
1652
+ let id: string; //Account Xero ID (default to undefined)
1653
+ let contactId: number; //Contact ID (default to undefined)
1654
+ let accountContactRequestModel: AccountContactRequestModel; //Update Account Contact Request (optional)
1599
1655
 
1600
- const { status, data } = await apiInstance.putUpdateAccountContact(
1601
- email,
1656
+ const { status, data } = await apiInstance.putAdminUpdateAccountContact(
1657
+ id,
1658
+ contactId,
1602
1659
  accountContactRequestModel
1603
1660
  );
1604
1661
  ```
@@ -1607,8 +1664,9 @@ const { status, data } = await apiInstance.putUpdateAccountContact(
1607
1664
 
1608
1665
  |Name | Type | Description | Notes|
1609
1666
  |------------- | ------------- | ------------- | -------------|
1610
- | **accountContactRequestModel** | **AccountContactRequestModel**| Account request | |
1611
- | **email** | [**string**] | Contact Email Address | defaults to undefined|
1667
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
1668
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
1669
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
1612
1670
 
1613
1671
 
1614
1672
  ### Return type
@@ -1628,17 +1686,17 @@ No authorization required
1628
1686
  ### HTTP response details
1629
1687
  | Status code | Description | Response headers |
1630
1688
  |-------------|-------------|------------------|
1631
- |**200** | No Response | - |
1689
+ |**204** | No Response | - |
1632
1690
  |**400** | Bad Request | - |
1633
1691
  |**401** | Unauthorised | - |
1634
1692
  |**403** | Access Denied | - |
1635
1693
 
1636
1694
  [[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)
1637
1695
 
1638
- # **putUpdateBillingAddress**
1639
- > putUpdateBillingAddress()
1696
+ # **putUpdateAccountContact**
1697
+ > putUpdateAccountContact()
1640
1698
 
1641
- Update Account Billing Address
1699
+ Update Account Contacts
1642
1700
 
1643
1701
  ### Example
1644
1702
 
@@ -1646,18 +1704,18 @@ Update Account Billing Address
1646
1704
  import {
1647
1705
  AccountsApi,
1648
1706
  Configuration,
1649
- AddressDTO
1707
+ AccountContactRequestModel
1650
1708
  } from 'yellowgrid-api-ts';
1651
1709
 
1652
1710
  const configuration = new Configuration();
1653
1711
  const apiInstance = new AccountsApi(configuration);
1654
1712
 
1655
- let id: string; //Xero ID (default to undefined)
1656
- let addressDTO: AddressDTO; //Updated Billing Address (optional)
1713
+ let email: string; //Contact Email Address (default to undefined)
1714
+ let accountContactRequestModel: AccountContactRequestModel; //Account request (optional)
1657
1715
 
1658
- const { status, data } = await apiInstance.putUpdateBillingAddress(
1659
- id,
1660
- addressDTO
1716
+ const { status, data } = await apiInstance.putUpdateAccountContact(
1717
+ email,
1718
+ accountContactRequestModel
1661
1719
  );
1662
1720
  ```
1663
1721
 
@@ -1665,8 +1723,8 @@ const { status, data } = await apiInstance.putUpdateBillingAddress(
1665
1723
 
1666
1724
  |Name | Type | Description | Notes|
1667
1725
  |------------- | ------------- | ------------- | -------------|
1668
- | **addressDTO** | **AddressDTO**| Updated Billing Address | |
1669
- | **id** | [**string**] | Xero ID | defaults to undefined|
1726
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Account request | |
1727
+ | **email** | [**string**] | Contact Email Address | defaults to undefined|
1670
1728
 
1671
1729
 
1672
1730
  ### Return type
@@ -1686,17 +1744,17 @@ No authorization required
1686
1744
  ### HTTP response details
1687
1745
  | Status code | Description | Response headers |
1688
1746
  |-------------|-------------|------------------|
1689
- |**204** | No Response | - |
1747
+ |**200** | No Response | - |
1690
1748
  |**400** | Bad Request | - |
1691
1749
  |**401** | Unauthorised | - |
1692
1750
  |**403** | Access Denied | - |
1693
1751
 
1694
1752
  [[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)
1695
1753
 
1696
- # **putUpdateContact**
1697
- > putUpdateContact()
1754
+ # **putUpdateBillingAddress**
1755
+ > putUpdateBillingAddress()
1698
1756
 
1699
- Update Account Contact
1757
+ Update Account Billing Address
1700
1758
 
1701
1759
  ### Example
1702
1760
 
@@ -1704,20 +1762,18 @@ Update Account Contact
1704
1762
  import {
1705
1763
  AccountsApi,
1706
1764
  Configuration,
1707
- AccountContactRequestModel
1765
+ AddressDTO
1708
1766
  } from 'yellowgrid-api-ts';
1709
1767
 
1710
1768
  const configuration = new Configuration();
1711
1769
  const apiInstance = new AccountsApi(configuration);
1712
1770
 
1713
- let id: string; //Account Xero ID (default to undefined)
1714
- let contactId: number; //Contact ID (default to undefined)
1715
- let accountContactRequestModel: AccountContactRequestModel; //Update Account Contact Request (optional)
1771
+ let id: string; //Xero ID (default to undefined)
1772
+ let addressDTO: AddressDTO; //Updated Billing Address (optional)
1716
1773
 
1717
- const { status, data } = await apiInstance.putUpdateContact(
1774
+ const { status, data } = await apiInstance.putUpdateBillingAddress(
1718
1775
  id,
1719
- contactId,
1720
- accountContactRequestModel
1776
+ addressDTO
1721
1777
  );
1722
1778
  ```
1723
1779
 
@@ -1725,9 +1781,8 @@ const { status, data } = await apiInstance.putUpdateContact(
1725
1781
 
1726
1782
  |Name | Type | Description | Notes|
1727
1783
  |------------- | ------------- | ------------- | -------------|
1728
- | **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
1729
- | **id** | [**string**] | Account Xero ID | defaults to undefined|
1730
- | **contactId** | [**number**] | Contact ID | defaults to undefined|
1784
+ | **addressDTO** | **AddressDTO**| Updated Billing Address | |
1785
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1731
1786
 
1732
1787
 
1733
1788
  ### Return type
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.135-dev.0",
3
+ "version": "3.2.137-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {