yellowgrid-api-ts 3.1.13-dev.0 → 3.1.15-dev.0

package/.openapi-generator/FILES

@@ -1,6 +1,5 @@
 .gitignore
 .npmignore
-.openapi-generator-ignore
 README.md
 api.ts
 base.ts
@@ -17,7 +16,6 @@ docs/AccountsApi.md
 docs/AccountsResponseModel.md
 docs/AddressModel.md
 docs/AddressRequestModel.md
-docs/AdminItemRequestDTO.md
 docs/AdminOrderRequestDTO.md
 docs/AdminUserModel.md
 docs/AgentHoursGraphModel.md
@@ -52,6 +50,8 @@ docs/CustomerPriceListEnum.md
 docs/CustomerSummaryReportDTO.md
 docs/DdiRangeRequestModel.md
 docs/DdiRangesRequestModel.md
+docs/DetailedItemRequestDTO.md
+docs/DetailedOrderRequestDTO.md
 docs/DivertRequestModel.md
 docs/DivertResponseModel.md
 docs/EdTechProClientEntity.md

package/README.md

@@ -138,6 +138,7 @@ Class | Method | HTTP request | Description
 *OAuth20Api* | [**postGetIdentity**](docs/OAuth20Api.md#postgetidentity) | **POST** /oauth2/me | Get Token Identity
 *OAuth20Api* | [**postPortalLogin**](docs/OAuth20Api.md#postportallogin) | **POST** /oauth2/portal/login | Portal Login
 *OrdersApi* | [**deleteUpdateOrder**](docs/OrdersApi.md#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders
+*OrdersApi* | [**getGetAdminEditableOrder**](docs/OrdersApi.md#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)
 *OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order
 *OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders
 *OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
@@ -231,7 +232,6 @@ Class | Method | HTTP request | Description
  - [AccountsResponseModel](docs/AccountsResponseModel.md)
  - [AddressModel](docs/AddressModel.md)
  - [AddressRequestModel](docs/AddressRequestModel.md)
- - [AdminItemRequestDTO](docs/AdminItemRequestDTO.md)
  - [AdminOrderRequestDTO](docs/AdminOrderRequestDTO.md)
  - [AdminUserModel](docs/AdminUserModel.md)
  - [AgentHoursGraphModel](docs/AgentHoursGraphModel.md)
@@ -260,6 +260,8 @@ Class | Method | HTTP request | Description
  - [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)
  - [DdiRangeRequestModel](docs/DdiRangeRequestModel.md)
  - [DdiRangesRequestModel](docs/DdiRangesRequestModel.md)
+ - [DetailedItemRequestDTO](docs/DetailedItemRequestDTO.md)
+ - [DetailedOrderRequestDTO](docs/DetailedOrderRequestDTO.md)
  - [DivertRequestModel](docs/DivertRequestModel.md)
  - [DivertResponseModel](docs/DivertResponseModel.md)
  - [EdTechProClientEntity](docs/EdTechProClientEntity.md)

package/api.ts

@@ -657,85 +657,6 @@ export interface AddressRequestModel {
      */
     'addressPostcode'?: string;
 }
-/**
- * Admin Order Item Request
- * @export
- * @interface AdminItemRequestDTO
- */
-export interface AdminItemRequestDTO {
-    /**
-     * SKU
-     * @type {string}
-     * @memberof AdminItemRequestDTO
-     */
-    'sku'?: string;
-    /**
-     * Quantity
-     * @type {number}
-     * @memberof AdminItemRequestDTO
-     */
-    'quantity'?: number;
-    /**
-     * ID
-     * @type {number}
-     * @memberof AdminItemRequestDTO
-     */
-    'id'?: number | null;
-    /**
-     * 3CX Licence Key
-     * @type {string}
-     * @memberof AdminItemRequestDTO
-     */
-    'licenceKey'?: string | null;
-    /**
-     * 3CX Hosting
-     * @type {boolean}
-     * @memberof AdminItemRequestDTO
-     */
-    'hosting'?: boolean | null;
-    /**
-     * Date Time
-     * @type {string}
-     * @memberof AdminItemRequestDTO
-     */
-    'processDate'?: string;
-    /**
-     * 3CX Sales Code
-     * @type {string}
-     * @memberof AdminItemRequestDTO
-     */
-    'tcxSalesCode'?: string | null;
-    /**
-     * SBCS
-     * @type {Array<TcxSbcDTO>}
-     * @memberof AdminItemRequestDTO
-     */
-    'sbcs'?: Array<TcxSbcDTO>;
-    /**
-     * Read Only (Cannot be edited)
-     * @type {boolean}
-     * @memberof AdminItemRequestDTO
-     */
-    'readOnly'?: boolean;
-    /**
-     * Title
-     * @type {string}
-     * @memberof AdminItemRequestDTO
-     */
-    'title'?: string | null;
-    /**
-     * Price (£)
-     * @type {number}
-     * @memberof AdminItemRequestDTO
-     */
-    'itemPrice'?: number | null;
-    /**
-     * Additional Discount
-     * @type {number}
-     * @memberof AdminItemRequestDTO
-     */
-    'additionalDiscount'?: number | null;
-}
 /**
  * Admin Order Request
  * @export
@@ -750,10 +671,10 @@ export interface AdminOrderRequestDTO {
     'orderReference'?: string | null;
     /**
      * Items
-     * @type {Array<AdminItemRequestDTO>}
+     * @type {Array<DetailedItemRequestDTO>}
      * @memberof AdminOrderRequestDTO
      */
-    'items'?: Array<AdminItemRequestDTO>;
+    'items'?: Array<DetailedItemRequestDTO>;
     /**
      * 
      * @type {ShippingServiceDTO}
@@ -1999,6 +1920,134 @@ export interface DdiRangesRequestModel {
      */
     'ranges'?: Array<DdiRangeRequestModel>;
 }
+/**
+ * Detailed Order Item Request
+ * @export
+ * @interface DetailedItemRequestDTO
+ */
+export interface DetailedItemRequestDTO {
+    /**
+     * SKU
+     * @type {string}
+     * @memberof DetailedItemRequestDTO
+     */
+    'sku'?: string;
+    /**
+     * Quantity
+     * @type {number}
+     * @memberof DetailedItemRequestDTO
+     */
+    'quantity'?: number;
+    /**
+     * ID
+     * @type {number}
+     * @memberof DetailedItemRequestDTO
+     */
+    'id'?: number | null;
+    /**
+     * 3CX Licence Key
+     * @type {string}
+     * @memberof DetailedItemRequestDTO
+     */
+    'licenceKey'?: string | null;
+    /**
+     * 3CX Hosting
+     * @type {boolean}
+     * @memberof DetailedItemRequestDTO
+     */
+    'hosting'?: boolean | null;
+    /**
+     * Date Time
+     * @type {string}
+     * @memberof DetailedItemRequestDTO
+     */
+    'processDate'?: string;
+    /**
+     * 3CX Sales Code
+     * @type {string}
+     * @memberof DetailedItemRequestDTO
+     */
+    'tcxSalesCode'?: string | null;
+    /**
+     * SBCS
+     * @type {Array<TcxSbcDTO>}
+     * @memberof DetailedItemRequestDTO
+     */
+    'sbcs'?: Array<TcxSbcDTO>;
+    /**
+     * Read Only (Cannot be edited)
+     * @type {boolean}
+     * @memberof DetailedItemRequestDTO
+     */
+    'readOnly'?: boolean;
+    /**
+     * Title
+     * @type {string}
+     * @memberof DetailedItemRequestDTO
+     */
+    'title'?: string | null;
+    /**
+     * Price (£)
+     * @type {number}
+     * @memberof DetailedItemRequestDTO
+     */
+    'itemPrice'?: number | null;
+    /**
+     * Additional Discount
+     * @type {number}
+     * @memberof DetailedItemRequestDTO
+     */
+    'additionalDiscount'?: number | null;
+}
+/**
+ * Detailed Order Request
+ * @export
+ * @interface DetailedOrderRequestDTO
+ */
+export interface DetailedOrderRequestDTO {
+    /**
+     * Order Reference
+     * @type {string}
+     * @memberof DetailedOrderRequestDTO
+     */
+    'orderReference'?: string | null;
+    /**
+     * Items
+     * @type {Array<DetailedItemRequestDTO>}
+     * @memberof DetailedOrderRequestDTO
+     */
+    'items'?: Array<DetailedItemRequestDTO>;
+    /**
+     * 
+     * @type {ShippingServiceDTO}
+     * @memberof DetailedOrderRequestDTO
+     */
+    'shippingService'?: ShippingServiceDTO;
+    /**
+     * Provisioning URL
+     * @type {string}
+     * @memberof DetailedOrderRequestDTO
+     */
+    'provisioningUrl'?: string | null;
+    /**
+     * 
+     * @type {AddressModel}
+     * @memberof DetailedOrderRequestDTO
+     */
+    'shippingAddress'?: AddressModel;
+    /**
+     * Part Ship Order
+     * @type {boolean}
+     * @memberof DetailedOrderRequestDTO
+     */
+    'partShip'?: boolean;
+    /**
+     * Quote
+     * @type {boolean}
+     * @memberof DetailedOrderRequestDTO
+     */
+    'quote'?: boolean;
+}
 /**
  * Divert Request
  * @export
@@ -3129,6 +3178,12 @@ export interface ItemDiscountEntity {
      * @memberof ItemDiscountEntity
      */
     'discount'?: number;
+    /**
+     * type
+     * @type {string}
+     * @memberof ItemDiscountEntity
+     */
+    'type'?: ItemDiscountEntityTypeEnum | null;
     /**
      * description
      * @type {string}
@@ -3142,6 +3197,15 @@ export interface ItemDiscountEntity {
      */
     'priority'?: number;
 }
+
+export const ItemDiscountEntityTypeEnum = {
+    TcxPhones: 'TCX_PHONES',
+    PhoneBulk: 'PHONE_BULK',
+    Additional: 'ADDITIONAL'
+} as const;
+
+export type ItemDiscountEntityTypeEnum = typeof ItemDiscountEntityTypeEnum[keyof typeof ItemDiscountEntityTypeEnum];
+
 /**
  * ItemsEntity
  * @export
@@ -3249,7 +3313,7 @@ export interface ItemEntity {
      * @type {string}
      * @memberof ItemEntity
      */
-    'licencekey'?: string;
+    'licenceKey'?: string;
     /**
      * addHosting
      * @type {number}
@@ -4720,6 +4784,12 @@ export interface ProductSummaryDTO {
      * @memberof ProductSummaryDTO
      */
     'rrp'?: number | null;
+    /**
+     * 
+     * @type {TcxLicenceDetailsModel}
+     * @memberof ProductSummaryDTO
+     */
+    'licenceDetails'?: TcxLicenceDetailsModel | null;
 }
 /**
  * PromoCodesEntity
@@ -16326,6 +16396,40 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get Editable Order (Admin)
+         * @summary Get Editable Order (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetAdminEditableOrder: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetAdminEditableOrder', 'id', id)
+            const localVarPath = `/admin/orders/{id}/views/editable`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // 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: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -16621,6 +16725,19 @@ export const OrdersApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.deleteUpdateOrder']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Editable Order (Admin)
+         * @summary Get Editable Order (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetAdminEditableOrder(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetAdminEditableOrder']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Editable Order
          * @summary Get Editable Order
@@ -16628,7 +16745,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminOrderRequestDTO>> {
+        async getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DetailedOrderRequestDTO>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getGetEditableOrder(id, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['OrdersApi.getGetEditableOrder']?.[localVarOperationServerIndex]?.url;
@@ -16731,6 +16848,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
         deleteUpdateOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
             return localVarFp.deleteUpdateOrder(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Editable Order (Admin)
+         * @summary Get Editable Order (Admin)
+         * @param {number} id Order ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO> {
+            return localVarFp.getGetAdminEditableOrder(id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Editable Order
          * @summary Get Editable Order
@@ -16738,7 +16865,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminOrderRequestDTO> {
+        getGetEditableOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<DetailedOrderRequestDTO> {
             return localVarFp.getGetEditableOrder(id, options).then((request) => request(axios, basePath));
         },
         /**
@@ -16825,6 +16952,18 @@ export class OrdersApi extends BaseAPI {
         return OrdersApiFp(this.configuration).deleteUpdateOrder(id, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Editable Order (Admin)
+     * @summary Get Editable Order (Admin)
+     * @param {number} id Order ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    public getGetAdminEditableOrder(id: number, options?: RawAxiosRequestConfig) {
+        return OrdersApiFp(this.configuration).getGetAdminEditableOrder(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Editable Order
      * @summary Get Editable Order