yellowgrid-api-ts 3.2.46 → 3.2.47-dev.0

package/dist/src/models/ServiceHealthDTO.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ServiceStatusDTO } from './ServiceStatusDTO';
+/**
+ * Service Health DTO
+ * @export
+ * @interface ServiceHealthDTO
+ */
+export interface ServiceHealthDTO {
+    /**
+     *
+     * @type {Array<ServiceStatusDTO>}
+     * @memberof ServiceHealthDTO
+     */
+    services?: Array<ServiceStatusDTO>;
+    /**
+     *
+     * @type {number}
+     * @memberof ServiceHealthDTO
+     */
+    globalStatus?: ServiceHealthDTOGlobalStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const ServiceHealthDTOGlobalStatusEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type ServiceHealthDTOGlobalStatusEnum = typeof ServiceHealthDTOGlobalStatusEnum[keyof typeof ServiceHealthDTOGlobalStatusEnum];
+/**
+ * Check if a given object implements the ServiceHealthDTO interface.
+ */
+export declare function instanceOfServiceHealthDTO(value: object): value is ServiceHealthDTO;
+export declare function ServiceHealthDTOFromJSON(json: any): ServiceHealthDTO;
+export declare function ServiceHealthDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): ServiceHealthDTO;
+export declare function ServiceHealthDTOToJSON(json: any): ServiceHealthDTO;
+export declare function ServiceHealthDTOToJSONTyped(value?: ServiceHealthDTO | null, ignoreDiscriminator?: boolean): any;

package/dist/src/models/ServiceHealthDTO.js

@@ -0,0 +1,61 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceHealthDTOGlobalStatusEnum = void 0;
+exports.instanceOfServiceHealthDTO = instanceOfServiceHealthDTO;
+exports.ServiceHealthDTOFromJSON = ServiceHealthDTOFromJSON;
+exports.ServiceHealthDTOFromJSONTyped = ServiceHealthDTOFromJSONTyped;
+exports.ServiceHealthDTOToJSON = ServiceHealthDTOToJSON;
+exports.ServiceHealthDTOToJSONTyped = ServiceHealthDTOToJSONTyped;
+var ServiceStatusDTO_1 = require("./ServiceStatusDTO");
+/**
+ * @export
+ */
+exports.ServiceHealthDTOGlobalStatusEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+};
+/**
+ * Check if a given object implements the ServiceHealthDTO interface.
+ */
+function instanceOfServiceHealthDTO(value) {
+    return true;
+}
+function ServiceHealthDTOFromJSON(json) {
+    return ServiceHealthDTOFromJSONTyped(json, false);
+}
+function ServiceHealthDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'services': json['services'] == null ? undefined : (json['services'].map(ServiceStatusDTO_1.ServiceStatusDTOFromJSON)),
+        'globalStatus': json['globalStatus'] == null ? undefined : json['globalStatus'],
+    };
+}
+function ServiceHealthDTOToJSON(json) {
+    return ServiceHealthDTOToJSONTyped(json, false);
+}
+function ServiceHealthDTOToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'services': value['services'] == null ? undefined : (value['services'].map(ServiceStatusDTO_1.ServiceStatusDTOToJSON)),
+        'globalStatus': value['globalStatus'],
+    };
+}

package/dist/src/models/ServiceHealthEnum.d.ts

@@ -0,0 +1,19 @@
+export declare const ServiceHealthEnum: {
+    readonly ONLINE: {
+        readonly name: "ONLINE";
+        readonly value: 0;
+        readonly publicValue: "Online";
+    };
+    readonly DEGRADED: {
+        readonly name: "DEGRADED";
+        readonly value: 1;
+        readonly publicValue: "Degraded";
+    };
+    readonly OFFLINE: {
+        readonly name: "OFFLINE";
+        readonly value: 2;
+        readonly publicValue: "Offline";
+    };
+};
+export type ServiceHealthEnum = typeof ServiceHealthEnum;
+export declare function ServiceHealthEnumCases(): any;

package/dist/src/models/ServiceHealthEnum.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceHealthEnum = void 0;
+exports.ServiceHealthEnumCases = ServiceHealthEnumCases;
+exports.ServiceHealthEnum = {
+    "ONLINE": {
+        "name": "ONLINE",
+        "value": 0,
+        "publicValue": "Online"
+    },
+    "DEGRADED": {
+        "name": "DEGRADED",
+        "value": 1,
+        "publicValue": "Degraded"
+    },
+    "OFFLINE": {
+        "name": "OFFLINE",
+        "value": 2,
+        "publicValue": "Offline"
+    }
+};
+function ServiceHealthEnumCases() {
+    return Object.keys(exports.ServiceHealthEnum).map(function (key) { return exports.ServiceHealthEnum[key]; });
+}

package/dist/src/models/ServiceStatusDTO.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { EventDTO } from './EventDTO';
+/**
+ * Service Status DTO
+ * @export
+ * @interface ServiceStatusDTO
+ */
+export interface ServiceStatusDTO {
+    /**
+     * Service Status Description
+     * @type {string}
+     * @memberof ServiceStatusDTO
+     */
+    statusName?: string;
+    /**
+     * Service Name
+     * @type {string}
+     * @memberof ServiceStatusDTO
+     */
+    name?: string;
+    /**
+     * Service Status
+     * @type {number}
+     * @memberof ServiceStatusDTO
+     */
+    status?: ServiceStatusDTOStatusEnum;
+    /**
+     * Service Events
+     * @type {Array<EventDTO>}
+     * @memberof ServiceStatusDTO
+     */
+    events?: Array<EventDTO>;
+}
+/**
+ * @export
+ */
+export declare const ServiceStatusDTOStatusEnum: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+};
+export type ServiceStatusDTOStatusEnum = typeof ServiceStatusDTOStatusEnum[keyof typeof ServiceStatusDTOStatusEnum];
+/**
+ * Check if a given object implements the ServiceStatusDTO interface.
+ */
+export declare function instanceOfServiceStatusDTO(value: object): value is ServiceStatusDTO;
+export declare function ServiceStatusDTOFromJSON(json: any): ServiceStatusDTO;
+export declare function ServiceStatusDTOFromJSONTyped(json: any, ignoreDiscriminator: boolean): ServiceStatusDTO;
+export declare function ServiceStatusDTOToJSON(json: any): ServiceStatusDTO;
+export declare function ServiceStatusDTOToJSONTyped(value?: ServiceStatusDTO | null, ignoreDiscriminator?: boolean): any;

package/dist/src/models/ServiceStatusDTO.js

@@ -0,0 +1,65 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceStatusDTOStatusEnum = void 0;
+exports.instanceOfServiceStatusDTO = instanceOfServiceStatusDTO;
+exports.ServiceStatusDTOFromJSON = ServiceStatusDTOFromJSON;
+exports.ServiceStatusDTOFromJSONTyped = ServiceStatusDTOFromJSONTyped;
+exports.ServiceStatusDTOToJSON = ServiceStatusDTOToJSON;
+exports.ServiceStatusDTOToJSONTyped = ServiceStatusDTOToJSONTyped;
+var EventDTO_1 = require("./EventDTO");
+/**
+ * @export
+ */
+exports.ServiceStatusDTOStatusEnum = {
+    NUMBER_0: 0,
+    NUMBER_1: 1,
+    NUMBER_2: 2
+};
+/**
+ * Check if a given object implements the ServiceStatusDTO interface.
+ */
+function instanceOfServiceStatusDTO(value) {
+    return true;
+}
+function ServiceStatusDTOFromJSON(json) {
+    return ServiceStatusDTOFromJSONTyped(json, false);
+}
+function ServiceStatusDTOFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'statusName': json['statusName'] == null ? undefined : json['statusName'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'events': json['events'] == null ? undefined : (json['events'].map(EventDTO_1.EventDTOFromJSON)),
+    };
+}
+function ServiceStatusDTOToJSON(json) {
+    return ServiceStatusDTOToJSONTyped(json, false);
+}
+function ServiceStatusDTOToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'statusName': value['statusName'],
+        'name': value['name'],
+        'status': value['status'],
+        'events': value['events'] == null ? undefined : (value['events'].map(EventDTO_1.EventDTOToJSON)),
+    };
+}

package/dist/src/models/ServiceStatusEnum.d.ts

@@ -0,0 +1,19 @@
+export declare const ServiceStatusEnum: {
+    readonly ONLINE: {
+        readonly name: "ONLINE";
+        readonly value: 0;
+        readonly publicValue: "Online";
+    };
+    readonly MINOR_INCIDENT: {
+        readonly name: "MINOR_INCIDENT";
+        readonly value: 1;
+        readonly publicValue: "Experiencing Incident";
+    };
+    readonly MAJOR_INCIDENT: {
+        readonly name: "MAJOR_INCIDENT";
+        readonly value: 2;
+        readonly publicValue: "Experiencing Major Incident";
+    };
+};
+export type ServiceStatusEnum = typeof ServiceStatusEnum;
+export declare function ServiceStatusEnumCases(): any;

package/dist/src/models/ServiceStatusEnum.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceStatusEnum = void 0;
+exports.ServiceStatusEnumCases = ServiceStatusEnumCases;
+exports.ServiceStatusEnum = {
+    "ONLINE": {
+        "name": "ONLINE",
+        "value": 0,
+        "publicValue": "Online"
+    },
+    "MINOR_INCIDENT": {
+        "name": "MINOR_INCIDENT",
+        "value": 1,
+        "publicValue": "Experiencing Incident"
+    },
+    "MAJOR_INCIDENT": {
+        "name": "MAJOR_INCIDENT",
+        "value": 2,
+        "publicValue": "Experiencing Major Incident"
+    }
+};
+function ServiceStatusEnumCases() {
+    return Object.keys(exports.ServiceStatusEnum).map(function (key) { return exports.ServiceStatusEnum[key]; });
+}

package/dist/src/models/ShipmentAddressEntity.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * ShipmentAddressEntity
+ * @export
+ * @interface ShipmentAddressEntity
+ */
+export interface ShipmentAddressEntity {
+    /**
+     * id
+     * @type {number}
+     * @memberof ShipmentAddressEntity
+     */
+    id?: number;
+    /**
+     * shipmentId
+     * @type {number}
+     * @memberof ShipmentAddressEntity
+     */
+    shipmentId?: number;
+    /**
+     * shipName
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipName?: string;
+    /**
+     * shipCompany
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipCompany?: string;
+    /**
+     * shipAddress1
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipAddress1?: string;
+    /**
+     * shipAddress2
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipAddress2?: string;
+    /**
+     * shipCity
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipCity?: string;
+    /**
+     * shipStateRegion
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipStateRegion?: string;
+    /**
+     * shipPostalCode
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipPostalCode?: string;
+    /**
+     * shipCountry
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipCountry?: string;
+    /**
+     * shipPhoneNumber
+     * @type {string}
+     * @memberof ShipmentAddressEntity
+     */
+    shipPhoneNumber?: string;
+}
+/**
+ * Check if a given object implements the ShipmentAddressEntity interface.
+ */
+export declare function instanceOfShipmentAddressEntity(value: object): value is ShipmentAddressEntity;
+export declare function ShipmentAddressEntityFromJSON(json: any): ShipmentAddressEntity;
+export declare function ShipmentAddressEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShipmentAddressEntity;
+export declare function ShipmentAddressEntityToJSON(json: any): ShipmentAddressEntity;
+export declare function ShipmentAddressEntityToJSONTyped(value?: ShipmentAddressEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/src/models/ShipmentAddressEntity.js

@@ -0,0 +1,69 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfShipmentAddressEntity = instanceOfShipmentAddressEntity;
+exports.ShipmentAddressEntityFromJSON = ShipmentAddressEntityFromJSON;
+exports.ShipmentAddressEntityFromJSONTyped = ShipmentAddressEntityFromJSONTyped;
+exports.ShipmentAddressEntityToJSON = ShipmentAddressEntityToJSON;
+exports.ShipmentAddressEntityToJSONTyped = ShipmentAddressEntityToJSONTyped;
+/**
+ * Check if a given object implements the ShipmentAddressEntity interface.
+ */
+function instanceOfShipmentAddressEntity(value) {
+    return true;
+}
+function ShipmentAddressEntityFromJSON(json) {
+    return ShipmentAddressEntityFromJSONTyped(json, false);
+}
+function ShipmentAddressEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'shipmentId': json['shipmentId'] == null ? undefined : json['shipmentId'],
+        'shipName': json['shipName'] == null ? undefined : json['shipName'],
+        'shipCompany': json['shipCompany'] == null ? undefined : json['shipCompany'],
+        'shipAddress1': json['shipAddress1'] == null ? undefined : json['shipAddress1'],
+        'shipAddress2': json['shipAddress2'] == null ? undefined : json['shipAddress2'],
+        'shipCity': json['shipCity'] == null ? undefined : json['shipCity'],
+        'shipStateRegion': json['shipStateRegion'] == null ? undefined : json['shipStateRegion'],
+        'shipPostalCode': json['shipPostalCode'] == null ? undefined : json['shipPostalCode'],
+        'shipCountry': json['shipCountry'] == null ? undefined : json['shipCountry'],
+        'shipPhoneNumber': json['shipPhoneNumber'] == null ? undefined : json['shipPhoneNumber'],
+    };
+}
+function ShipmentAddressEntityToJSON(json) {
+    return ShipmentAddressEntityToJSONTyped(json, false);
+}
+function ShipmentAddressEntityToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'shipmentId': value['shipmentId'],
+        'shipName': value['shipName'],
+        'shipCompany': value['shipCompany'],
+        'shipAddress1': value['shipAddress1'],
+        'shipAddress2': value['shipAddress2'],
+        'shipCity': value['shipCity'],
+        'shipStateRegion': value['shipStateRegion'],
+        'shipPostalCode': value['shipPostalCode'],
+        'shipCountry': value['shipCountry'],
+        'shipPhoneNumber': value['shipPhoneNumber'],
+    };
+}

package/dist/src/models/ShipmentEntity.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * ShipmentsEntity
+ * @export
+ * @interface ShipmentEntity
+ */
+export interface ShipmentEntity {
+    /**
+     * id
+     * @type {number}
+     * @memberof ShipmentEntity
+     */
+    id?: number;
+    /**
+     * batchId
+     * @type {number}
+     * @memberof ShipmentEntity
+     */
+    batchId?: number;
+    /**
+     * courier
+     * @type {string}
+     * @memberof ShipmentEntity
+     */
+    courier?: string;
+    /**
+     * courierService
+     * @type {string}
+     * @memberof ShipmentEntity
+     */
+    courierService?: string;
+    /**
+     * courierServiceDesc
+     * @type {string}
+     * @memberof ShipmentEntity
+     */
+    courierServiceDesc?: string;
+    /**
+     * courierReference
+     * @type {string}
+     * @memberof ShipmentEntity
+     */
+    courierReference?: string;
+    /**
+     * courierTracking
+     * @type {string}
+     * @memberof ShipmentEntity
+     */
+    courierTracking?: string;
+    /**
+     * courierBoxes
+     * @type {number}
+     * @memberof ShipmentEntity
+     */
+    courierBoxes?: number;
+    /**
+     * mac
+     * @type {string}
+     * @memberof ShipmentEntity
+     */
+    scannedData?: string;
+    /**
+     * date
+     * @type {string}
+     * @memberof ShipmentEntity
+     */
+    dateShipped?: string;
+    /**
+     * requestDate
+     * @type {string}
+     * @memberof ShipmentEntity
+     */
+    requestDate?: string;
+    /**
+     * provId
+     * @type {number}
+     * @memberof ShipmentEntity
+     */
+    provId?: number;
+}
+/**
+ * Check if a given object implements the ShipmentEntity interface.
+ */
+export declare function instanceOfShipmentEntity(value: object): value is ShipmentEntity;
+export declare function ShipmentEntityFromJSON(json: any): ShipmentEntity;
+export declare function ShipmentEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): ShipmentEntity;
+export declare function ShipmentEntityToJSON(json: any): ShipmentEntity;
+export declare function ShipmentEntityToJSONTyped(value?: ShipmentEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/src/models/ShipmentEntity.js

@@ -0,0 +1,71 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfShipmentEntity = instanceOfShipmentEntity;
+exports.ShipmentEntityFromJSON = ShipmentEntityFromJSON;
+exports.ShipmentEntityFromJSONTyped = ShipmentEntityFromJSONTyped;
+exports.ShipmentEntityToJSON = ShipmentEntityToJSON;
+exports.ShipmentEntityToJSONTyped = ShipmentEntityToJSONTyped;
+/**
+ * Check if a given object implements the ShipmentEntity interface.
+ */
+function instanceOfShipmentEntity(value) {
+    return true;
+}
+function ShipmentEntityFromJSON(json) {
+    return ShipmentEntityFromJSONTyped(json, false);
+}
+function ShipmentEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'batchId': json['batchId'] == null ? undefined : json['batchId'],
+        'courier': json['courier'] == null ? undefined : json['courier'],
+        'courierService': json['courierService'] == null ? undefined : json['courierService'],
+        'courierServiceDesc': json['courierServiceDesc'] == null ? undefined : json['courierServiceDesc'],
+        'courierReference': json['courierReference'] == null ? undefined : json['courierReference'],
+        'courierTracking': json['courierTracking'] == null ? undefined : json['courierTracking'],
+        'courierBoxes': json['courierBoxes'] == null ? undefined : json['courierBoxes'],
+        'scannedData': json['scannedData'] == null ? undefined : json['scannedData'],
+        'dateShipped': json['dateShipped'] == null ? undefined : json['dateShipped'],
+        'requestDate': json['requestDate'] == null ? undefined : json['requestDate'],
+        'provId': json['provId'] == null ? undefined : json['provId'],
+    };
+}
+function ShipmentEntityToJSON(json) {
+    return ShipmentEntityToJSONTyped(json, false);
+}
+function ShipmentEntityToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'batchId': value['batchId'],
+        'courier': value['courier'],
+        'courierService': value['courierService'],
+        'courierServiceDesc': value['courierServiceDesc'],
+        'courierReference': value['courierReference'],
+        'courierTracking': value['courierTracking'],
+        'courierBoxes': value['courierBoxes'],
+        'scannedData': value['scannedData'],
+        'dateShipped': value['dateShipped'],
+        'requestDate': value['requestDate'],
+        'provId': value['provId'],
+    };
+}