yellowgrid-api-ts 3.2.48 → 3.2.49-dev.0

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

@@ -0,0 +1,374 @@
+/**
+ * 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.
+ */
+/**
+ * OrdersEntity
+ * @export
+ * @interface OrderEntity
+ */
+export interface OrderEntity {
+    /**
+     * id
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    id?: number;
+    /**
+     * externalId
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    reference?: string;
+    /**
+     * sourceId
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    sourceId?: number;
+    /**
+     * sageInv
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    invoiceNumber?: string;
+    /**
+     * invoiceId
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    invoiceId?: string | null;
+    /**
+     * creditAccountId
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    customerId?: number;
+    /**
+     * orderDate
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    orderDate?: string;
+    /**
+     * orderPostedDate
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    orderPostedDate?: string;
+    /**
+     * buyerEmail
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    buyerEmail?: string;
+    /**
+     * buyerPhone
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    buyerPhone?: string;
+    /**
+     * buyerName
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    buyerName?: string;
+    /**
+     * buyerCompany
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    buyerCompany?: string;
+    /**
+     * billName
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    billName?: string;
+    /**
+     * billAddress1
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    billAddress1?: string;
+    /**
+     * billAddress2
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    billAddress2?: string;
+    /**
+     * billAddress3
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    billAddress3?: string;
+    /**
+     * billCity
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    billCity?: string;
+    /**
+     * billStateRegion
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    billStateRegion?: string;
+    /**
+     * billPostalCode
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    billPostalCode?: string;
+    /**
+     * billCountry
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    billCountry?: string;
+    /**
+     * shipName
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipName?: string;
+    /**
+     * shipCompany
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipCompany?: string;
+    /**
+     * shipAddress1
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipAddress1?: string;
+    /**
+     * shipAddress2
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipAddress2?: string;
+    /**
+     * shipAddress3
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipAddress3?: string;
+    /**
+     * shipCity
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipCity?: string;
+    /**
+     * shipStateRegion
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipStateRegion?: string;
+    /**
+     * shipPostalCode
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipPostalCode?: string;
+    /**
+     * shipCountry
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipCountry?: string;
+    /**
+     * shipVatNumber
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipVatNumber?: string;
+    /**
+     * shipPhoneNumber
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipPhoneNumber?: string;
+    /**
+     * shipCourier
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipCourier?: string;
+    /**
+     * shipMethod
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipMethod?: string;
+    /**
+     * shipServiceLevel
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipServiceLevel?: string;
+    /**
+     * shipTrackingId
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    shipTrackingId?: string;
+    /**
+     * currency
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    currency?: string;
+    /**
+     * taxRate
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    taxRate?: number;
+    /**
+     * taxAmount
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    taxAmount?: number;
+    /**
+     * taxAmountGbp
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    taxAmountGbp?: number;
+    /**
+     * paidStatus
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    paidStatus?: number;
+    /**
+     * invoicePaid
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    invoicePaid?: number;
+    /**
+     * quoteStatus
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    quote?: number;
+    /**
+     * sageStatus
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    sageStatus?: string;
+    /**
+     * transactionId
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    transactionId?: string;
+    /**
+     * customerInvoiceSent
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    customerInvoiceSent?: number;
+    /**
+     * supplierOrderedStatus
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    supplierOrderedStatus?: number;
+    /**
+     * supplierPaidStatus
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    supplierPaidStatus?: number;
+    /**
+     * supplierRecvdStatus
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    supplierReceivedStatus?: number;
+    /**
+     * carriageRefunded
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    carriageRefunded?: number;
+    /**
+     * amazonMinus
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    amazonMinus?: number;
+    /**
+     * currencyRate
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    currencyRate?: number;
+    /**
+     * hzStatus
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    hzStatus?: number;
+    /**
+     * prospect
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    prospect?: number;
+    /**
+     * provisioningUrl
+     * @type {number}
+     * @memberof OrderEntity
+     */
+    provisioningUrl?: number;
+    /**
+     * uniqueId
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    uniqueId?: string;
+    /**
+     * notes
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    notes?: string;
+    /**
+     * promocode
+     * @type {string}
+     * @memberof OrderEntity
+     */
+    promocode?: string;
+    /**
+     * fulfillable
+     * @type {boolean}
+     * @memberof OrderEntity
+     */
+    fulfillable?: boolean | null;
+}
+/**
+ * Check if a given object implements the OrderEntity interface.
+ */
+export declare function instanceOfOrderEntity(value: object): value is OrderEntity;
+export declare function OrderEntityFromJSON(json: any): OrderEntity;
+export declare function OrderEntityFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderEntity;
+export declare function OrderEntityToJSON(json: any): OrderEntity;
+export declare function OrderEntityToJSONTyped(value?: OrderEntity | null, ignoreDiscriminator?: boolean): any;

package/dist/src/models/OrderEntity.js

@@ -0,0 +1,163 @@
+"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.instanceOfOrderEntity = instanceOfOrderEntity;
+exports.OrderEntityFromJSON = OrderEntityFromJSON;
+exports.OrderEntityFromJSONTyped = OrderEntityFromJSONTyped;
+exports.OrderEntityToJSON = OrderEntityToJSON;
+exports.OrderEntityToJSONTyped = OrderEntityToJSONTyped;
+/**
+ * Check if a given object implements the OrderEntity interface.
+ */
+function instanceOfOrderEntity(value) {
+    return true;
+}
+function OrderEntityFromJSON(json) {
+    return OrderEntityFromJSONTyped(json, false);
+}
+function OrderEntityFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'reference': json['reference'] == null ? undefined : json['reference'],
+        'sourceId': json['sourceId'] == null ? undefined : json['sourceId'],
+        'invoiceNumber': json['invoiceNumber'] == null ? undefined : json['invoiceNumber'],
+        'invoiceId': json['invoiceId'] == null ? undefined : json['invoiceId'],
+        'customerId': json['customerId'] == null ? undefined : json['customerId'],
+        'orderDate': json['orderDate'] == null ? undefined : json['orderDate'],
+        'orderPostedDate': json['orderPostedDate'] == null ? undefined : json['orderPostedDate'],
+        'buyerEmail': json['buyerEmail'] == null ? undefined : json['buyerEmail'],
+        'buyerPhone': json['buyerPhone'] == null ? undefined : json['buyerPhone'],
+        'buyerName': json['buyerName'] == null ? undefined : json['buyerName'],
+        'buyerCompany': json['buyerCompany'] == null ? undefined : json['buyerCompany'],
+        'billName': json['billName'] == null ? undefined : json['billName'],
+        'billAddress1': json['billAddress1'] == null ? undefined : json['billAddress1'],
+        'billAddress2': json['billAddress2'] == null ? undefined : json['billAddress2'],
+        'billAddress3': json['billAddress3'] == null ? undefined : json['billAddress3'],
+        'billCity': json['billCity'] == null ? undefined : json['billCity'],
+        'billStateRegion': json['billStateRegion'] == null ? undefined : json['billStateRegion'],
+        'billPostalCode': json['billPostalCode'] == null ? undefined : json['billPostalCode'],
+        'billCountry': json['billCountry'] == null ? undefined : json['billCountry'],
+        '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'],
+        'shipAddress3': json['shipAddress3'] == null ? undefined : json['shipAddress3'],
+        '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'],
+        'shipVatNumber': json['shipVatNumber'] == null ? undefined : json['shipVatNumber'],
+        'shipPhoneNumber': json['shipPhoneNumber'] == null ? undefined : json['shipPhoneNumber'],
+        'shipCourier': json['shipCourier'] == null ? undefined : json['shipCourier'],
+        'shipMethod': json['shipMethod'] == null ? undefined : json['shipMethod'],
+        'shipServiceLevel': json['shipServiceLevel'] == null ? undefined : json['shipServiceLevel'],
+        'shipTrackingId': json['shipTrackingId'] == null ? undefined : json['shipTrackingId'],
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'taxRate': json['taxRate'] == null ? undefined : json['taxRate'],
+        'taxAmount': json['taxAmount'] == null ? undefined : json['taxAmount'],
+        'taxAmountGbp': json['taxAmountGbp'] == null ? undefined : json['taxAmountGbp'],
+        'paidStatus': json['paidStatus'] == null ? undefined : json['paidStatus'],
+        'invoicePaid': json['invoicePaid'] == null ? undefined : json['invoicePaid'],
+        'quote': json['quote'] == null ? undefined : json['quote'],
+        'sageStatus': json['sageStatus'] == null ? undefined : json['sageStatus'],
+        'transactionId': json['transactionId'] == null ? undefined : json['transactionId'],
+        'customerInvoiceSent': json['customerInvoiceSent'] == null ? undefined : json['customerInvoiceSent'],
+        'supplierOrderedStatus': json['supplierOrderedStatus'] == null ? undefined : json['supplierOrderedStatus'],
+        'supplierPaidStatus': json['supplierPaidStatus'] == null ? undefined : json['supplierPaidStatus'],
+        'supplierReceivedStatus': json['supplierReceivedStatus'] == null ? undefined : json['supplierReceivedStatus'],
+        'carriageRefunded': json['carriageRefunded'] == null ? undefined : json['carriageRefunded'],
+        'amazonMinus': json['amazonMinus'] == null ? undefined : json['amazonMinus'],
+        'currencyRate': json['currencyRate'] == null ? undefined : json['currencyRate'],
+        'hzStatus': json['hzStatus'] == null ? undefined : json['hzStatus'],
+        'prospect': json['prospect'] == null ? undefined : json['prospect'],
+        'provisioningUrl': json['provisioningUrl'] == null ? undefined : json['provisioningUrl'],
+        'uniqueId': json['uniqueId'] == null ? undefined : json['uniqueId'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'promocode': json['promocode'] == null ? undefined : json['promocode'],
+        'fulfillable': json['fulfillable'] == null ? undefined : json['fulfillable'],
+    };
+}
+function OrderEntityToJSON(json) {
+    return OrderEntityToJSONTyped(json, false);
+}
+function OrderEntityToJSONTyped(value, ignoreDiscriminator) {
+    if (ignoreDiscriminator === void 0) { ignoreDiscriminator = false; }
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'reference': value['reference'],
+        'sourceId': value['sourceId'],
+        'invoiceNumber': value['invoiceNumber'],
+        'invoiceId': value['invoiceId'],
+        'customerId': value['customerId'],
+        'orderDate': value['orderDate'],
+        'orderPostedDate': value['orderPostedDate'],
+        'buyerEmail': value['buyerEmail'],
+        'buyerPhone': value['buyerPhone'],
+        'buyerName': value['buyerName'],
+        'buyerCompany': value['buyerCompany'],
+        'billName': value['billName'],
+        'billAddress1': value['billAddress1'],
+        'billAddress2': value['billAddress2'],
+        'billAddress3': value['billAddress3'],
+        'billCity': value['billCity'],
+        'billStateRegion': value['billStateRegion'],
+        'billPostalCode': value['billPostalCode'],
+        'billCountry': value['billCountry'],
+        'shipName': value['shipName'],
+        'shipCompany': value['shipCompany'],
+        'shipAddress1': value['shipAddress1'],
+        'shipAddress2': value['shipAddress2'],
+        'shipAddress3': value['shipAddress3'],
+        'shipCity': value['shipCity'],
+        'shipStateRegion': value['shipStateRegion'],
+        'shipPostalCode': value['shipPostalCode'],
+        'shipCountry': value['shipCountry'],
+        'shipVatNumber': value['shipVatNumber'],
+        'shipPhoneNumber': value['shipPhoneNumber'],
+        'shipCourier': value['shipCourier'],
+        'shipMethod': value['shipMethod'],
+        'shipServiceLevel': value['shipServiceLevel'],
+        'shipTrackingId': value['shipTrackingId'],
+        'currency': value['currency'],
+        'taxRate': value['taxRate'],
+        'taxAmount': value['taxAmount'],
+        'taxAmountGbp': value['taxAmountGbp'],
+        'paidStatus': value['paidStatus'],
+        'invoicePaid': value['invoicePaid'],
+        'quote': value['quote'],
+        'sageStatus': value['sageStatus'],
+        'transactionId': value['transactionId'],
+        'customerInvoiceSent': value['customerInvoiceSent'],
+        'supplierOrderedStatus': value['supplierOrderedStatus'],
+        'supplierPaidStatus': value['supplierPaidStatus'],
+        'supplierReceivedStatus': value['supplierReceivedStatus'],
+        'carriageRefunded': value['carriageRefunded'],
+        'amazonMinus': value['amazonMinus'],
+        'currencyRate': value['currencyRate'],
+        'hzStatus': value['hzStatus'],
+        'prospect': value['prospect'],
+        'provisioningUrl': value['provisioningUrl'],
+        'uniqueId': value['uniqueId'],
+        'notes': value['notes'],
+        'promocode': value['promocode'],
+        'fulfillable': value['fulfillable'],
+    };
+}

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

@@ -0,0 +1,120 @@
+/**
+ * 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.
+ */
+/**
+ * EdTechPro Order Request
+ * @export
+ * @interface OrderRequestModel
+ */
+export interface OrderRequestModel {
+    /**
+     * Client/Trust ID
+     * @type {number}
+     * @memberof OrderRequestModel
+     */
+    clientId?: number | null;
+    /**
+     * Client/Trust Name
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    clientName?: string | null;
+    /**
+     * Client/Trust Contact Name
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    clientContactName?: string | null;
+    /**
+     * Client/Trust Contact Email
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    clientContactEmail?: string | null;
+    /**
+     * Agreed to Terms and Conditions
+     * @type {boolean}
+     * @memberof OrderRequestModel
+     */
+    terms?: boolean | null;
+    /**
+     * School Name
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    schoolName?: string;
+    /**
+     * School DfE Code
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    dfECode?: string;
+    /**
+     * School Technical Contact Name
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    schoolContactName?: string;
+    /**
+     * School Technical Contact Email
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    schoolContactEmail?: string;
+    /**
+     * Licence Type
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    licenceType?: OrderRequestModelLicenceTypeEnum;
+    /**
+     * School Type
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    schoolType?: OrderRequestModelSchoolTypeEnum;
+    /**
+     * InstanceId
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    instanceId?: string | null;
+    /**
+     * Order Reference
+     * @type {string}
+     * @memberof OrderRequestModel
+     */
+    orderReference?: string | null;
+}
+/**
+ * @export
+ */
+export declare const OrderRequestModelLicenceTypeEnum: {
+    readonly Lite: "lite";
+    readonly Pro: "pro";
+};
+export type OrderRequestModelLicenceTypeEnum = typeof OrderRequestModelLicenceTypeEnum[keyof typeof OrderRequestModelLicenceTypeEnum];
+/**
+ * @export
+ */
+export declare const OrderRequestModelSchoolTypeEnum: {
+    readonly Primary: "primary";
+    readonly Secondary: "secondary";
+};
+export type OrderRequestModelSchoolTypeEnum = typeof OrderRequestModelSchoolTypeEnum[keyof typeof OrderRequestModelSchoolTypeEnum];
+/**
+ * Check if a given object implements the OrderRequestModel interface.
+ */
+export declare function instanceOfOrderRequestModel(value: object): value is OrderRequestModel;
+export declare function OrderRequestModelFromJSON(json: any): OrderRequestModel;
+export declare function OrderRequestModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): OrderRequestModel;
+export declare function OrderRequestModelToJSON(json: any): OrderRequestModel;
+export declare function OrderRequestModelToJSONTyped(value?: OrderRequestModel | null, ignoreDiscriminator?: boolean): any;