yellowgrid-api-ts 3.2.135-dev.0 → 3.2.136-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.
Files changed (6) hide show
  1. package/README.md +3 -3
  2. package/api.ts +136 -136
  3. package/dist/api.d.ts +72 -72
  4. package/dist/api.js +161 -161
  5. package/docs/AccountsApi.md +67 -67
  6. package/package.json +1 -1
package/docs/AccountsApi.md CHANGED
@@ -4,9 +4,9 @@ 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
10
  |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
11
11
  |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
12
12
  |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
@@ -23,7 +23,7 @@ All URIs are relative to *https://localhost*
23
23
  |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
24
24
  |[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
25
25
  |[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
26
- |[**postCreateContact**](#postcreatecontact) | **POST** /admin/accounts/{id}/contacts/ | |
26
+ |[**postAdminCreateAccountContact**](#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts/ | |
27
27
  |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
28
28
  |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
29
29
  |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
@@ -32,15 +32,15 @@ All URIs are relative to *https://localhost*
32
32
  |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
33
33
  |[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
34
34
  |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
35
+ |[**putAdminUpdateAccountContact**](#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
35
36
  |[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
36
37
  |[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
37
- |[**putUpdateContact**](#putupdatecontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | |
38
38
  |[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
39
39
 
40
- # **deleteDeleteClientCredentials**
41
- > deleteDeleteClientCredentials()
40
+ # **deleteAdminUpdateAccountContact**
41
+ > deleteAdminUpdateAccountContact()
42
42
 
43
- Delete client credentials
43
+ Delete Account Contact
44
44
 
45
45
  ### Example
46
46
 
@@ -53,10 +53,12 @@ import {
53
53
  const configuration = new Configuration();
54
54
  const apiInstance = new AccountsApi(configuration);
55
55
 
56
- let id: string; //OAuth 2.0 Client ID (default to undefined)
56
+ let id: string; //Account Xero ID (default to undefined)
57
+ let contactId: number; //Contact ID (default to undefined)
57
58
 
58
- const { status, data } = await apiInstance.deleteDeleteClientCredentials(
59
- id
59
+ const { status, data } = await apiInstance.deleteAdminUpdateAccountContact(
60
+ id,
61
+ contactId
60
62
  );
61
63
  ```
62
64
 
@@ -64,7 +66,8 @@ const { status, data } = await apiInstance.deleteDeleteClientCredentials(
64
66
 
65
67
  |Name | Type | Description | Notes|
66
68
  |------------- | ------------- | ------------- | -------------|
67
- | **id** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
69
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
70
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
68
71
 
69
72
 
70
73
  ### Return type
@@ -84,17 +87,17 @@ No authorization required
84
87
  ### HTTP response details
85
88
  | Status code | Description | Response headers |
86
89
  |-------------|-------------|------------------|
87
- |**200** | No Response | - |
90
+ |**204** | No Response | - |
88
91
  |**400** | Bad Request | - |
89
92
  |**401** | Unauthorised | - |
90
93
  |**403** | Access Denied | - |
91
94
 
92
95
  [[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)
93
96
 
94
- # **deleteUpdateAccountContact**
95
- > deleteUpdateAccountContact()
97
+ # **deleteDeleteClientCredentials**
98
+ > deleteDeleteClientCredentials()
96
99
 
97
- Delete Account Contacts
100
+ Delete client credentials
98
101
 
99
102
  ### Example
100
103
 
@@ -107,10 +110,10 @@ import {
107
110
  const configuration = new Configuration();
108
111
  const apiInstance = new AccountsApi(configuration);
109
112
 
110
- let email: string; //Contact Email Address (default to undefined)
113
+ let id: string; //OAuth 2.0 Client ID (default to undefined)
111
114
 
112
- const { status, data } = await apiInstance.deleteUpdateAccountContact(
113
- email
115
+ const { status, data } = await apiInstance.deleteDeleteClientCredentials(
116
+ id
114
117
  );
115
118
  ```
116
119
 
@@ -118,7 +121,7 @@ const { status, data } = await apiInstance.deleteUpdateAccountContact(
118
121
 
119
122
  |Name | Type | Description | Notes|
120
123
  |------------- | ------------- | ------------- | -------------|
121
- | **email** | [**string**] | Contact Email Address | defaults to undefined|
124
+ | **id** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
122
125
 
123
126
 
124
127
  ### Return type
@@ -145,10 +148,10 @@ No authorization required
145
148
 
146
149
  [[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
150
 
148
- # **deleteUpdateContact**
149
- > deleteUpdateContact()
151
+ # **deleteUpdateAccountContact**
152
+ > deleteUpdateAccountContact()
150
153
 
151
- Delete Account Contact
154
+ Delete Account Contacts
152
155
 
153
156
  ### Example
154
157
 
@@ -161,12 +164,10 @@ import {
161
164
  const configuration = new Configuration();
162
165
  const apiInstance = new AccountsApi(configuration);
163
166
 
164
- let id: string; //Account Xero ID (default to undefined)
165
- let contactId: number; //Contact ID (default to undefined)
167
+ let email: string; //Contact Email Address (default to undefined)
166
168
 
167
- const { status, data } = await apiInstance.deleteUpdateContact(
168
- id,
169
- contactId
169
+ const { status, data } = await apiInstance.deleteUpdateAccountContact(
170
+ email
170
171
  );
171
172
  ```
172
173
 
@@ -174,8 +175,7 @@ const { status, data } = await apiInstance.deleteUpdateContact(
174
175
 
175
176
  |Name | Type | Description | Notes|
176
177
  |------------- | ------------- | ------------- | -------------|
177
- | **id** | [**string**] | Account Xero ID | defaults to undefined|
178
- | **contactId** | [**number**] | Contact ID | defaults to undefined|
178
+ | **email** | [**string**] | Contact Email Address | defaults to undefined|
179
179
 
180
180
 
181
181
  ### Return type
@@ -195,7 +195,7 @@ No authorization required
195
195
  ### HTTP response details
196
196
  | Status code | Description | Response headers |
197
197
  |-------------|-------------|------------------|
198
- |**204** | No Response | - |
198
+ |**200** | No Response | - |
199
199
  |**400** | Bad Request | - |
200
200
  |**401** | Unauthorised | - |
201
201
  |**403** | Access Denied | - |
@@ -1081,8 +1081,8 @@ No authorization required
1081
1081
 
1082
1082
  [[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
1083
 
1084
- # **postCreateContact**
1085
- > postCreateContact()
1084
+ # **postAdminCreateAccountContact**
1085
+ > postAdminCreateAccountContact()
1086
1086
 
1087
1087
  Create Account Contact
1088
1088
 
@@ -1101,7 +1101,7 @@ const apiInstance = new AccountsApi(configuration);
1101
1101
  let id: string; //Account Xero ID (default to undefined)
1102
1102
  let accountContactRequestModel: AccountContactRequestModel; //Create Account Contact Request (optional)
1103
1103
 
1104
- const { status, data } = await apiInstance.postCreateContact(
1104
+ const { status, data } = await apiInstance.postAdminCreateAccountContact(
1105
1105
  id,
1106
1106
  accountContactRequestModel
1107
1107
  );
@@ -1577,10 +1577,10 @@ No authorization required
1577
1577
 
1578
1578
  [[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
1579
 
1580
- # **putUpdateAccountContact**
1581
- > putUpdateAccountContact()
1580
+ # **putAdminUpdateAccountContact**
1581
+ > putAdminUpdateAccountContact()
1582
1582
 
1583
- Update Account Contacts
1583
+ Update Account Contact
1584
1584
 
1585
1585
  ### Example
1586
1586
 
@@ -1594,11 +1594,13 @@ import {
1594
1594
  const configuration = new Configuration();
1595
1595
  const apiInstance = new AccountsApi(configuration);
1596
1596
 
1597
- let email: string; //Contact Email Address (default to undefined)
1598
- let accountContactRequestModel: AccountContactRequestModel; //Account request (optional)
1597
+ let id: string; //Account Xero ID (default to undefined)
1598
+ let contactId: number; //Contact ID (default to undefined)
1599
+ let accountContactRequestModel: AccountContactRequestModel; //Update Account Contact Request (optional)
1599
1600
 
1600
- const { status, data } = await apiInstance.putUpdateAccountContact(
1601
- email,
1601
+ const { status, data } = await apiInstance.putAdminUpdateAccountContact(
1602
+ id,
1603
+ contactId,
1602
1604
  accountContactRequestModel
1603
1605
  );
1604
1606
  ```
@@ -1607,8 +1609,9 @@ const { status, data } = await apiInstance.putUpdateAccountContact(
1607
1609
 
1608
1610
  |Name | Type | Description | Notes|
1609
1611
  |------------- | ------------- | ------------- | -------------|
1610
- | **accountContactRequestModel** | **AccountContactRequestModel**| Account request | |
1611
- | **email** | [**string**] | Contact Email Address | defaults to undefined|
1612
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
1613
+ | **id** | [**string**] | Account Xero ID | defaults to undefined|
1614
+ | **contactId** | [**number**] | Contact ID | defaults to undefined|
1612
1615
 
1613
1616
 
1614
1617
  ### Return type
@@ -1628,17 +1631,17 @@ No authorization required
1628
1631
  ### HTTP response details
1629
1632
  | Status code | Description | Response headers |
1630
1633
  |-------------|-------------|------------------|
1631
- |**200** | No Response | - |
1634
+ |**204** | No Response | - |
1632
1635
  |**400** | Bad Request | - |
1633
1636
  |**401** | Unauthorised | - |
1634
1637
  |**403** | Access Denied | - |
1635
1638
 
1636
1639
  [[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
1640
 
1638
- # **putUpdateBillingAddress**
1639
- > putUpdateBillingAddress()
1641
+ # **putUpdateAccountContact**
1642
+ > putUpdateAccountContact()
1640
1643
 
1641
- Update Account Billing Address
1644
+ Update Account Contacts
1642
1645
 
1643
1646
  ### Example
1644
1647
 
@@ -1646,18 +1649,18 @@ Update Account Billing Address
1646
1649
  import {
1647
1650
  AccountsApi,
1648
1651
  Configuration,
1649
- AddressDTO
1652
+ AccountContactRequestModel
1650
1653
  } from 'yellowgrid-api-ts';
1651
1654
 
1652
1655
  const configuration = new Configuration();
1653
1656
  const apiInstance = new AccountsApi(configuration);
1654
1657
 
1655
- let id: string; //Xero ID (default to undefined)
1656
- let addressDTO: AddressDTO; //Updated Billing Address (optional)
1658
+ let email: string; //Contact Email Address (default to undefined)
1659
+ let accountContactRequestModel: AccountContactRequestModel; //Account request (optional)
1657
1660
 
1658
- const { status, data } = await apiInstance.putUpdateBillingAddress(
1659
- id,
1660
- addressDTO
1661
+ const { status, data } = await apiInstance.putUpdateAccountContact(
1662
+ email,
1663
+ accountContactRequestModel
1661
1664
  );
1662
1665
  ```
1663
1666
 
@@ -1665,8 +1668,8 @@ const { status, data } = await apiInstance.putUpdateBillingAddress(
1665
1668
 
1666
1669
  |Name | Type | Description | Notes|
1667
1670
  |------------- | ------------- | ------------- | -------------|
1668
- | **addressDTO** | **AddressDTO**| Updated Billing Address | |
1669
- | **id** | [**string**] | Xero ID | defaults to undefined|
1671
+ | **accountContactRequestModel** | **AccountContactRequestModel**| Account request | |
1672
+ | **email** | [**string**] | Contact Email Address | defaults to undefined|
1670
1673
 
1671
1674
 
1672
1675
  ### Return type
@@ -1686,17 +1689,17 @@ No authorization required
1686
1689
  ### HTTP response details
1687
1690
  | Status code | Description | Response headers |
1688
1691
  |-------------|-------------|------------------|
1689
- |**204** | No Response | - |
1692
+ |**200** | No Response | - |
1690
1693
  |**400** | Bad Request | - |
1691
1694
  |**401** | Unauthorised | - |
1692
1695
  |**403** | Access Denied | - |
1693
1696
 
1694
1697
  [[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
1698
 
1696
- # **putUpdateContact**
1697
- > putUpdateContact()
1699
+ # **putUpdateBillingAddress**
1700
+ > putUpdateBillingAddress()
1698
1701
 
1699
- Update Account Contact
1702
+ Update Account Billing Address
1700
1703
 
1701
1704
  ### Example
1702
1705
 
@@ -1704,20 +1707,18 @@ Update Account Contact
1704
1707
  import {
1705
1708
  AccountsApi,
1706
1709
  Configuration,
1707
- AccountContactRequestModel
1710
+ AddressDTO
1708
1711
  } from 'yellowgrid-api-ts';
1709
1712
 
1710
1713
  const configuration = new Configuration();
1711
1714
  const apiInstance = new AccountsApi(configuration);
1712
1715
 
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)
1716
+ let id: string; //Xero ID (default to undefined)
1717
+ let addressDTO: AddressDTO; //Updated Billing Address (optional)
1716
1718
 
1717
- const { status, data } = await apiInstance.putUpdateContact(
1719
+ const { status, data } = await apiInstance.putUpdateBillingAddress(
1718
1720
  id,
1719
- contactId,
1720
- accountContactRequestModel
1721
+ addressDTO
1721
1722
  );
1722
1723
  ```
1723
1724
 
@@ -1725,9 +1726,8 @@ const { status, data } = await apiInstance.putUpdateContact(
1725
1726
 
1726
1727
  |Name | Type | Description | Notes|
1727
1728
  |------------- | ------------- | ------------- | -------------|
1728
- | **accountContactRequestModel** | **AccountContactRequestModel**| Update Account Contact Request | |
1729
- | **id** | [**string**] | Account Xero ID | defaults to undefined|
1730
- | **contactId** | [**number**] | Contact ID | defaults to undefined|
1729
+ | **addressDTO** | **AddressDTO**| Updated Billing Address | |
1730
+ | **id** | [**string**] | Xero ID | defaults to undefined|
1731
1731
 
1732
1732
 
1733
1733
  ### 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.136-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {