yellowgrid-api-ts 3.2.109-dev.0 → 3.2.112-dev.0

package/.openapi-generator/FILES

@@ -15,6 +15,7 @@ docs/AccountRequestModel.md
 docs/AccountSummaryDTO.md
 docs/AccountsApi.md
 docs/AccountsResponseModel.md
+docs/AddressDTO.md
 docs/AddressModel.md
 docs/AddressRequestModel.md
 docs/AdminNumberPortDTO.md

package/README.md

@@ -287,6 +287,7 @@ Class | Method | HTTP request | Description
  - [AccountRequestModel](docs/AccountRequestModel.md)
  - [AccountSummaryDTO](docs/AccountSummaryDTO.md)
  - [AccountsResponseModel](docs/AccountsResponseModel.md)
+ - [AddressDTO](docs/AddressDTO.md)
  - [AddressModel](docs/AddressModel.md)
  - [AddressRequestModel](docs/AddressRequestModel.md)
  - [AdminNumberPortDTO](docs/AdminNumberPortDTO.md)

package/api.ts

@@ -260,7 +260,7 @@ export interface AccountPageDetailsDTO {
      */
     'companyName'?: string;
     'billingAddress'?: AddressModel;
-    'defaultShippingAddress'?: AddressModel;
+    'shippingAddress'?: AddressModel;
     /**
      * Addresses
      */
@@ -389,6 +389,39 @@ export interface AccountsResponseModel {
      */
     'totalResults'?: number;
 }
+/**
+ * Address
+ */
+export interface AddressDTO {
+    /**
+     * Company
+     */
+    'company'?: string;
+    /**
+     * Address Line 1
+     */
+    'addressLine1'?: string;
+    /**
+     * Address Line 2
+     */
+    'addressLine2'?: string;
+    /**
+     * City
+     */
+    'city'?: string;
+    /**
+     * Region
+     */
+    'region'?: string;
+    /**
+     * Postal Code
+     */
+    'postalCode'?: string;
+    /**
+     * Country
+     */
+    'iso'?: string;
+}
 /**
  * Order Address
  */
@@ -8707,11 +8740,11 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
         /**
          * Update Account Billing Address
          * @param {string} id Xero ID
-         * @param {AddressModel} [addressModel] Updated Billing Address
+         * @param {AddressDTO} [addressDTO] Updated Billing Address
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        putUpdateBillingAddress: async (id: string, addressModel?: AddressModel, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        putUpdateBillingAddress: async (id: string, addressDTO?: AddressDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'id' is not null or undefined
             assertParamExists('putUpdateBillingAddress', 'id', id)
             const localVarPath = `/admin/accounts/{id}/billing/address`
@@ -8732,7 +8765,7 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(addressModel, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(addressDTO, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -9099,12 +9132,12 @@ export const AccountsApiFp = function(configuration?: Configuration) {
         /**
          * Update Account Billing Address
          * @param {string} id Xero ID
-         * @param {AddressModel} [addressModel] Updated Billing Address
+         * @param {AddressDTO} [addressDTO] Updated Billing Address
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.putUpdateBillingAddress(id, addressModel, options);
+        async putUpdateBillingAddress(id: string, addressDTO?: AddressDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.putUpdateBillingAddress(id, addressDTO, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['AccountsApi.putUpdateBillingAddress']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -9375,12 +9408,12 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
         /**
          * Update Account Billing Address
          * @param {string} id Xero ID
-         * @param {AddressModel} [addressModel] Updated Billing Address
+         * @param {AddressDTO} [addressDTO] Updated Billing Address
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): AxiosPromise<void> {
-            return localVarFp.putUpdateBillingAddress(id, addressModel, options).then((request) => request(axios, basePath));
+        putUpdateBillingAddress(id: string, addressDTO?: AddressDTO, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.putUpdateBillingAddress(id, addressDTO, options).then((request) => request(axios, basePath));
         },
         /**
          * Update Account Shipping Address
@@ -9667,12 +9700,12 @@ export class AccountsApi extends BaseAPI {
     /**
      * Update Account Billing Address
      * @param {string} id Xero ID
-     * @param {AddressModel} [addressModel] Updated Billing Address
+     * @param {AddressDTO} [addressDTO] Updated Billing Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig) {
-        return AccountsApiFp(this.configuration).putUpdateBillingAddress(id, addressModel, options).then((request) => request(this.axios, this.basePath));
+    public putUpdateBillingAddress(id: string, addressDTO?: AddressDTO, options?: RawAxiosRequestConfig) {
+        return AccountsApiFp(this.configuration).putUpdateBillingAddress(id, addressDTO, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/dist/api.d.ts

@@ -250,7 +250,7 @@ export interface AccountPageDetailsDTO {
      */
     'companyName'?: string;
     'billingAddress'?: AddressModel;
-    'defaultShippingAddress'?: AddressModel;
+    'shippingAddress'?: AddressModel;
     /**
      * Addresses
      */
@@ -379,6 +379,39 @@ export interface AccountsResponseModel {
      */
     'totalResults'?: number;
 }
+/**
+ * Address
+ */
+export interface AddressDTO {
+    /**
+     * Company
+     */
+    'company'?: string;
+    /**
+     * Address Line 1
+     */
+    'addressLine1'?: string;
+    /**
+     * Address Line 2
+     */
+    'addressLine2'?: string;
+    /**
+     * City
+     */
+    'city'?: string;
+    /**
+     * Region
+     */
+    'region'?: string;
+    /**
+     * Postal Code
+     */
+    'postalCode'?: string;
+    /**
+     * Country
+     */
+    'iso'?: string;
+}
 /**
  * Order Address
  */
@@ -7965,11 +7998,11 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
     /**
      * Update Account Billing Address
      * @param {string} id Xero ID
-     * @param {AddressModel} [addressModel] Updated Billing Address
+     * @param {AddressDTO} [addressDTO] Updated Billing Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    putUpdateBillingAddress: (id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    putUpdateBillingAddress: (id: string, addressDTO?: AddressDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update Account Shipping Address
      * @param {string} id Xero ID
@@ -8179,11 +8212,11 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
     /**
      * Update Account Billing Address
      * @param {string} id Xero ID
-     * @param {AddressModel} [addressModel] Updated Billing Address
+     * @param {AddressDTO} [addressDTO] Updated Billing Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    putUpdateBillingAddress(id: string, addressDTO?: AddressDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Update Account Shipping Address
      * @param {string} id Xero ID
@@ -8393,11 +8426,11 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
     /**
      * Update Account Billing Address
      * @param {string} id Xero ID
-     * @param {AddressModel} [addressModel] Updated Billing Address
+     * @param {AddressDTO} [addressDTO] Updated Billing Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    putUpdateBillingAddress(id: string, addressDTO?: AddressDTO, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Update Account Shipping Address
      * @param {string} id Xero ID
@@ -8607,11 +8640,11 @@ export declare class AccountsApi extends BaseAPI {
     /**
      * Update Account Billing Address
      * @param {string} id Xero ID
-     * @param {AddressModel} [addressModel] Updated Billing Address
+     * @param {AddressDTO} [addressDTO] Updated Billing Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    putUpdateBillingAddress(id: string, addressModel?: AddressModel, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    putUpdateBillingAddress(id: string, addressDTO?: AddressDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Update Account Shipping Address
      * @param {string} id Xero ID

package/dist/api.js

@@ -1340,16 +1340,16 @@ var AccountsApiAxiosParamCreator = function (configuration) {
         /**
          * Update Account Billing Address
          * @param {string} id Xero ID
-         * @param {AddressModel} [addressModel] Updated Billing Address
+         * @param {AddressDTO} [addressDTO] Updated Billing Address
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        putUpdateBillingAddress: function (id_1, addressModel_1) {
+        putUpdateBillingAddress: function (id_1, addressDTO_1) {
             var args_1 = [];
             for (var _i = 2; _i < arguments.length; _i++) {
                 args_1[_i - 2] = arguments[_i];
             }
-            return __awaiter(_this, __spreadArray([id_1, addressModel_1], args_1, true), void 0, function (id, addressModel, options) {
+            return __awaiter(_this, __spreadArray([id_1, addressDTO_1], args_1, true), void 0, function (id, addressDTO, options) {
                 var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
                 if (options === void 0) { options = {}; }
                 return __generator(this, function (_a) {
@@ -1368,7 +1368,7 @@ var AccountsApiAxiosParamCreator = function (configuration) {
                     (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
                     headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
                     localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(addressModel, localVarRequestOptions, configuration);
+                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(addressDTO, localVarRequestOptions, configuration);
                     return [2 /*return*/, {
                             url: (0, common_1.toPathString)(localVarUrlObj),
                             options: localVarRequestOptions,
@@ -1980,17 +1980,17 @@ var AccountsApiFp = function (configuration) {
         /**
          * Update Account Billing Address
          * @param {string} id Xero ID
-         * @param {AddressModel} [addressModel] Updated Billing Address
+         * @param {AddressDTO} [addressDTO] Updated Billing Address
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        putUpdateBillingAddress: function (id, addressModel, options) {
+        putUpdateBillingAddress: function (id, addressDTO, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
                 var _a, _b, _c;
                 return __generator(this, function (_d) {
                     switch (_d.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.putUpdateBillingAddress(id, addressModel, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.putUpdateBillingAddress(id, addressDTO, options)];
                         case 1:
                             localVarAxiosArgs = _d.sent();
                             localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
@@ -2276,12 +2276,12 @@ var AccountsApiFactory = function (configuration, basePath, axios) {
         /**
          * Update Account Billing Address
          * @param {string} id Xero ID
-         * @param {AddressModel} [addressModel] Updated Billing Address
+         * @param {AddressDTO} [addressDTO] Updated Billing Address
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        putUpdateBillingAddress: function (id, addressModel, options) {
-            return localVarFp.putUpdateBillingAddress(id, addressModel, options).then(function (request) { return request(axios, basePath); });
+        putUpdateBillingAddress: function (id, addressDTO, options) {
+            return localVarFp.putUpdateBillingAddress(id, addressDTO, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Update Account Shipping Address
@@ -2572,13 +2572,13 @@ var AccountsApi = /** @class */ (function (_super) {
     /**
      * Update Account Billing Address
      * @param {string} id Xero ID
-     * @param {AddressModel} [addressModel] Updated Billing Address
+     * @param {AddressDTO} [addressDTO] Updated Billing Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    AccountsApi.prototype.putUpdateBillingAddress = function (id, addressModel, options) {
+    AccountsApi.prototype.putUpdateBillingAddress = function (id, addressDTO, options) {
         var _this = this;
-        return (0, exports.AccountsApiFp)(this.configuration).putUpdateBillingAddress(id, addressModel, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.AccountsApiFp)(this.configuration).putUpdateBillingAddress(id, addressDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * Update Account Shipping Address

package/docs/AccountPageDetailsDTO.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **xeroId** | **string** | Xero ID | [optional] [default to undefined]
 **companyName** | **string** | Company | [optional] [default to undefined]
 **billingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
-**defaultShippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
 **previousShippingAddreses** | [**Array<AddressModel>**](AddressModel.md) | Addresses | [optional] [default to undefined]
 **portalAccess** | **boolean** | Portal Access | [optional] [default to undefined]
 **cname** | **string** | CNAME | [optional] [default to undefined]
@@ -24,7 +24,7 @@ const instance: AccountPageDetailsDTO = {
     xeroId,
     companyName,
     billingAddress,
-    defaultShippingAddress,
+    shippingAddress,
     previousShippingAddreses,
     portalAccess,
     cname,

package/docs/AccountsApi.md

@@ -1351,18 +1351,18 @@ Update Account Billing Address
 import {
     AccountsApi,
     Configuration,
-    AddressModel
+    AddressDTO
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new AccountsApi(configuration);
 
 let id: string; //Xero ID (default to undefined)
-let addressModel: AddressModel; //Updated Billing Address (optional)
+let addressDTO: AddressDTO; //Updated Billing Address (optional)
 
 const { status, data } = await apiInstance.putUpdateBillingAddress(
     id,
-    addressModel
+    addressDTO
 );
 ```
 
@@ -1370,7 +1370,7 @@ const { status, data } = await apiInstance.putUpdateBillingAddress(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **addressModel** | **AddressModel**| Updated Billing Address | |
+| **addressDTO** | **AddressDTO**| Updated Billing Address | |
 | **id** | [**string**] | Xero ID | defaults to undefined|
 
 

package/docs/AddressDTO.md

@@ -0,0 +1,33 @@
+# AddressDTO
+
+Address
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company** | **string** | Company | [optional] [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
+**city** | **string** | City | [optional] [default to undefined]
+**region** | **string** | Region | [optional] [default to undefined]
+**postalCode** | **string** | Postal Code | [optional] [default to undefined]
+**iso** | **string** | Country | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AddressDTO } from 'yellowgrid-api-ts';
+
+const instance: AddressDTO = {
+    company,
+    addressLine1,
+    addressLine2,
+    city,
+    region,
+    postalCode,
+    iso,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.109-dev.0",
+  "version": "3.2.112-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {