yellowgrid-api-ts 3.2.245-dev.0 → 3.2.247-dev.0

package/.openapi-generator/FILES

@@ -57,6 +57,8 @@ docs/Class3CXIntegrationsApi.md
 docs/Class3CXMultiTenantApi.md
 docs/ClientDetailsModel.md
 docs/ClientModel.md
+docs/CollectionDateDTO.md
+docs/CollectionDatesRequestDTO.md
 docs/CompanyContractModel.md
 docs/ConnectionRequest.md
 docs/ConnectionType.md

package/README.md

@@ -384,6 +384,7 @@ Class | Method | HTTP request | Description
 *ServicesApi* | [**postCreateEventUpdate**](docs/ServicesApi.md#postcreateeventupdate) | **POST** /services/events/{id}/updates | 
 *ServicesApi* | [**postSubscribe**](docs/ServicesApi.md#postsubscribe) | **POST** /services/events/subscribe | 
 *ShippingApi* | [**postGetAdminShippingServices**](docs/ShippingApi.md#postgetadminshippingservices) | **POST** /admin/shipping/services | Get Shipping Services
+*ShippingApi* | [**postGetCollectionDates**](docs/ShippingApi.md#postgetcollectiondates) | **POST** /shipping/collections/dates | 
 *ShippingApi* | [**postGetShippingServices**](docs/ShippingApi.md#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services
 *StockManagementApi* | [**deleteDeleteStockOrder**](docs/StockManagementApi.md#deletedeletestockorder) | **DELETE** /stock/orders/{id} | Delete Stock Order
 *StockManagementApi* | [**deleteDeleteStockOrderDeduction**](docs/StockManagementApi.md#deletedeletestockorderdeduction) | **DELETE** /stock/orders/{order_id}/deductions/{deduction_id} | Delete Stock Order Deduction
@@ -469,6 +470,8 @@ Class | Method | HTTP request | Description
  - [Cdr](docs/Cdr.md)
  - [ClientDetailsModel](docs/ClientDetailsModel.md)
  - [ClientModel](docs/ClientModel.md)
+ - [CollectionDateDTO](docs/CollectionDateDTO.md)
+ - [CollectionDatesRequestDTO](docs/CollectionDatesRequestDTO.md)
  - [CompanyContractModel](docs/CompanyContractModel.md)
  - [ConnectionRequest](docs/ConnectionRequest.md)
  - [ConnectionType](docs/ConnectionType.md)

package/api.ts

@@ -1754,6 +1754,40 @@ export interface ClientModel {
      */
     'created': string;
 }
+/**
+ * Collection Date
+ */
+export interface CollectionDateDTO {
+    /**
+     * Area Start Time
+     */
+    'startTime': string;
+    /**
+     * Area Finish Time
+     */
+    'finishTime': string;
+    /**
+     * Collection Cutoff Time
+     */
+    'cutOff': string;
+    /**
+     * Date Time
+     */
+    'date': string;
+}
+/**
+ * Collection Dates Request
+ */
+export interface CollectionDatesRequestDTO {
+    /**
+     * Post Code
+     */
+    'postCode': string;
+    /**
+     * ISO
+     */
+    'iso': string;
+}
 /**
  * Company Tech Support Contract
  */
@@ -35577,6 +35611,38 @@ export const ShippingApiAxiosParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get Collection Dates
+         * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetCollectionDates: async (collectionDatesRequestDTO?: CollectionDatesRequestDTO, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/shipping/collections/dates`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(collectionDatesRequestDTO, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -35633,6 +35699,18 @@ export const ShippingApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['ShippingApi.postGetAdminShippingServices']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Collection Dates
+         * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async postGetCollectionDates(collectionDatesRequestDTO?: CollectionDatesRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CollectionDateDTO>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postGetCollectionDates(collectionDatesRequestDTO, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ShippingApi.postGetCollectionDates']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -35666,6 +35744,15 @@ export const ShippingApiFactory = function (configuration?: Configuration, baseP
         postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShippingServicesModel> {
             return localVarFp.postGetAdminShippingServices(customerId, shippingInformationDTO, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Collection Dates
+         * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetCollectionDates(collectionDatesRequestDTO?: CollectionDatesRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<CollectionDateDTO>> {
+            return localVarFp.postGetCollectionDates(collectionDatesRequestDTO, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -35695,6 +35782,16 @@ export class ShippingApi extends BaseAPI {
         return ShippingApiFp(this.configuration).postGetAdminShippingServices(customerId, shippingInformationDTO, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Collection Dates
+     * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public postGetCollectionDates(collectionDatesRequestDTO?: CollectionDatesRequestDTO, options?: RawAxiosRequestConfig) {
+        return ShippingApiFp(this.configuration).postGetCollectionDates(collectionDatesRequestDTO, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Shipping Services
      * @summary Get Shipping Services

package/dist/api.d.ts

@@ -1716,6 +1716,40 @@ export interface ClientModel {
      */
     'created': string;
 }
+/**
+ * Collection Date
+ */
+export interface CollectionDateDTO {
+    /**
+     * Area Start Time
+     */
+    'startTime': string;
+    /**
+     * Area Finish Time
+     */
+    'finishTime': string;
+    /**
+     * Collection Cutoff Time
+     */
+    'cutOff': string;
+    /**
+     * Date Time
+     */
+    'date': string;
+}
+/**
+ * Collection Dates Request
+ */
+export interface CollectionDatesRequestDTO {
+    /**
+     * Post Code
+     */
+    'postCode': string;
+    /**
+     * ISO
+     */
+    'iso': string;
+}
 /**
  * Company Tech Support Contract
  */
@@ -22182,6 +22216,13 @@ export declare const ShippingApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     postGetAdminShippingServices: (customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Collection Dates
+     * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetCollectionDates: (collectionDatesRequestDTO?: CollectionDatesRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Shipping Services
      * @summary Get Shipping Services
@@ -22204,6 +22245,13 @@ export declare const ShippingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShippingServicesModel>>;
+    /**
+     * Get Collection Dates
+     * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetCollectionDates(collectionDatesRequestDTO?: CollectionDatesRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CollectionDateDTO>>>;
     /**
      * Get Shipping Services
      * @summary Get Shipping Services
@@ -22226,6 +22274,13 @@ export declare const ShippingApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): AxiosPromise<ShippingServicesModel>;
+    /**
+     * Get Collection Dates
+     * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetCollectionDates(collectionDatesRequestDTO?: CollectionDatesRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<Array<CollectionDateDTO>>;
     /**
      * Get Shipping Services
      * @summary Get Shipping Services
@@ -22248,6 +22303,13 @@ export declare class ShippingApi extends BaseAPI {
      * @throws {RequiredError}
      */
     postGetAdminShippingServices(customerId: number, shippingInformationDTO?: ShippingInformationDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShippingServicesModel, any, {}>>;
+    /**
+     * Get Collection Dates
+     * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetCollectionDates(collectionDatesRequestDTO?: CollectionDatesRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CollectionDateDTO[], any, {}>>;
     /**
      * Get Shipping Services
      * @summary Get Shipping Services

package/dist/api.js

@@ -30034,6 +30034,42 @@ var ShippingApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Collection Dates
+         * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetCollectionDates: function (collectionDatesRequestDTO_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([collectionDatesRequestDTO_1], args_1, true), void 0, function (collectionDatesRequestDTO, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    localVarPath = "/shipping/collections/dates";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Content-Type'] = 'application/json';
+                    localVarHeaderParameter['Accept'] = 'application/json';
+                    (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)(collectionDatesRequestDTO, localVarRequestOptions, configuration);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -30104,6 +30140,28 @@ var ShippingApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Get Collection Dates
+         * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetCollectionDates: function (collectionDatesRequestDTO, 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.postGetCollectionDates(collectionDatesRequestDTO, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ShippingApi.postGetCollectionDates']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -30147,6 +30205,15 @@ var ShippingApiFactory = function (configuration, basePath, axios) {
         postGetAdminShippingServices: function (customerId, shippingInformationDTO, options) {
             return localVarFp.postGetAdminShippingServices(customerId, shippingInformationDTO, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Get Collection Dates
+         * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postGetCollectionDates: function (collectionDatesRequestDTO, options) {
+            return localVarFp.postGetCollectionDates(collectionDatesRequestDTO, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Get Shipping Services
          * @summary Get Shipping Services
@@ -30180,6 +30247,16 @@ var ShippingApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.ShippingApiFp)(this.configuration).postGetAdminShippingServices(customerId, shippingInformationDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Get Collection Dates
+     * @param {CollectionDatesRequestDTO} [collectionDatesRequestDTO] Collection Dates Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    ShippingApi.prototype.postGetCollectionDates = function (collectionDatesRequestDTO, options) {
+        var _this = this;
+        return (0, exports.ShippingApiFp)(this.configuration).postGetCollectionDates(collectionDatesRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Get Shipping Services
      * @summary Get Shipping Services

package/docs/CollectionDateDTO.md

@@ -0,0 +1,27 @@
+# CollectionDateDTO
+
+Collection Date
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**startTime** | **string** | Area Start Time | [default to undefined]
+**finishTime** | **string** | Area Finish Time | [default to undefined]
+**cutOff** | **string** | Collection Cutoff Time | [default to undefined]
+**date** | **string** | Date Time | [default to undefined]
+
+## Example
+
+```typescript
+import { CollectionDateDTO } from 'yellowgrid-api-ts';
+
+const instance: CollectionDateDTO = {
+    startTime,
+    finishTime,
+    cutOff,
+    date,
+};
+```
+
+[[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/docs/CollectionDatesRequestDTO.md

@@ -0,0 +1,23 @@
+# CollectionDatesRequestDTO
+
+Collection Dates Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**postCode** | **string** | Post Code | [default to undefined]
+**iso** | **string** | ISO | [default to undefined]
+
+## Example
+
+```typescript
+import { CollectionDatesRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: CollectionDatesRequestDTO = {
+    postCode,
+    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/docs/ShippingApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**postGetAdminShippingServices**](#postgetadminshippingservices) | **POST** /admin/shipping/services | Get Shipping Services|
+|[**postGetCollectionDates**](#postgetcollectiondates) | **POST** /shipping/collections/dates | |
 |[**postGetShippingServices**](#postgetshippingservices) | **POST** /shipping/services | Get Shipping Services|
 
 # **postGetAdminShippingServices**
@@ -65,6 +66,61 @@ No authorization required
 
 [[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)
 
+# **postGetCollectionDates**
+> Array<CollectionDateDTO> postGetCollectionDates()
+
+Get Collection Dates
+
+### Example
+
+```typescript
+import {
+    ShippingApi,
+    Configuration,
+    CollectionDatesRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new ShippingApi(configuration);
+
+let collectionDatesRequestDTO: CollectionDatesRequestDTO; //Collection Dates Request (optional)
+
+const { status, data } = await apiInstance.postGetCollectionDates(
+    collectionDatesRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **collectionDatesRequestDTO** | **CollectionDatesRequestDTO**| Collection Dates Request | |
+
+
+### Return type
+
+**Array<CollectionDateDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Collection Dates |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[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)
+
 # **postGetShippingServices**
 > ShippingServicesModel postGetShippingServices()
 

package/package.json

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