yellowgrid-api-ts 3.2.85-dev.0 → 3.2.85

package/docs/SMSApi.md

@@ -1,11 +1,67 @@
 # SMSApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**postCreateSmsAccount**](#postcreatesmsaccount) | **POST** /messaging/sms/account | Create SMS Account|
 |[**postSendSms**](#postsendsms) | **POST** /messaging/sms/send | |
 
+# **postCreateSmsAccount**
+> SmsAccountDTO postCreateSmsAccount()
+
+Create SMS Account
+
+### Example
+
+```typescript
+import {
+    SMSApi,
+    Configuration,
+    SmsAccountRequestDTO
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new SMSApi(configuration);
+
+let smsAccountRequestDTO: SmsAccountRequestDTO; //SMS Account Request (optional)
+
+const { status, data } = await apiInstance.postCreateSmsAccount(
+    smsAccountRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **smsAccountRequestDTO** | **SmsAccountRequestDTO**| SMS Account Request | |
+
+
+### Return type
+
+**SmsAccountDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | SMS Account |  -  |
+|**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)
+
 # **postSendSms**
 > SmsDataModel postSendSms()
 

package/docs/ServicesApi.md

@@ -1,6 +1,6 @@
 # ServicesApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShippingApi.md

@@ -1,6 +1,6 @@
 # ShippingApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/ShippingRequestDTO.md

@@ -8,6 +8,8 @@ Name | Type | Description | Notes
 **courier** | **string** | Courier | [optional] [default to undefined]
 **service** | **string** | Courier Service | [optional] [default to undefined]
 **boxes** | **number** | Boxes | [optional] [default to undefined]
+**printer** | **number** | Printer | [optional] [default to undefined]
+**shipment** | [**ShipmentRequestDTO**](ShipmentRequestDTO.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -18,6 +20,8 @@ const instance: ShippingRequestDTO = {
     courier,
     service,
     boxes,
+    printer,
+    shipment,
 };
 ```
 

package/docs/SmsAccountDTO.md

@@ -0,0 +1,31 @@
+# SmsAccountDTO
+
+SMS Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sendUrl** | **string** | Send URL | [optional] [default to undefined]
+**webhookUrl** | **string** | Webhook URL | [optional] [default to undefined]
+**apiKey** | **string** | API Key | [optional] [default to undefined]
+**numbers** | [**Array<SmsNumbersEntity>**](SmsNumbersEntity.md) | Numbers | [optional] [default to undefined]
+**name** | **string** | Name | [optional] [default to undefined]
+**whitelist** | [**Array<SmsWhitelistEntity>**](SmsWhitelistEntity.md) | Sender Whitelist | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SmsAccountDTO } from 'yellowgrid-api-ts';
+
+const instance: SmsAccountDTO = {
+    sendUrl,
+    webhookUrl,
+    apiKey,
+    numbers,
+    name,
+    whitelist,
+};
+```
+
+[[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/SmsAccountRequestDTO.md

@@ -0,0 +1,29 @@
+# SmsAccountRequestDTO
+
+SMS Account Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | **number** | SMS Provider | [optional] [default to undefined]
+**name** | **string** | Customer Name | [optional] [default to undefined]
+**webhookUrl** | **string** | SMS Webhook | [optional] [default to undefined]
+**iso** | **string** | Number Country | [optional] [default to undefined]
+**type** | **string** | Number Type | [optional] [default to TypeEnum_Mobile]
+
+## Example
+
+```typescript
+import { SmsAccountRequestDTO } from 'yellowgrid-api-ts';
+
+const instance: SmsAccountRequestDTO = {
+    provider,
+    name,
+    webhookUrl,
+    iso,
+    type,
+};
+```
+
+[[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/StockManagementApi.md

@@ -1,6 +1,6 @@
 # StockManagementApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/SystemApi.md

@@ -1,6 +1,6 @@
 # SystemApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/TcxSbcDTO.md

@@ -6,6 +6,7 @@ SBC Data
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
 **ipAddress** | **string** | LAN IP Address | [optional] [default to undefined]
 **defaultGateway** | **string** | LAN Default Gateway | [optional] [default to undefined]
 **netmask** | **string** | LAN Subnet Mask | [optional] [default to undefined]
@@ -19,6 +20,7 @@ Name | Type | Description | Notes
 import { TcxSbcDTO } from 'yellowgrid-api-ts';
 
 const instance: TcxSbcDTO = {
+    id,
     ipAddress,
     defaultGateway,
     netmask,

package/docs/TicketsApi.md

@@ -1,6 +1,6 @@
 # TicketsApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/docs/WebhooksApi.md

@@ -1,6 +1,6 @@
 # WebhooksApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|

package/getEnums.php

@@ -1,31 +1,31 @@
-<?php
-
-use App\Contracts\Enums\PublicEnumInterface;
-
-require_once __DIR__."/../../../../vendor/autoload.php";
-
-$dir = __DIR__."/models";
-if (!is_dir($dir)) {
-    mkdir($dir);
-}
-foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
-    $ref = new ReflectionEnum($publicEnum->value);
-    $cases = [];
-    foreach ($ref->getCases() as $c) {
-        /** @var BackedEnum $enum */
-        $enum = $c->getEnum()->getName();
-        $value = $c->getBackingValue();
-        /** @var PublicEnumInterface $case */
-        $case = $enum::from($value);
-        $cases[$c->getName()] = [
-            "name" => $case->name,
-            "value" => $case->value,
-            "publicValue" => $case->getPublicValue()
-        ];
-    }
-    $enumName = $ref->getShortName();
-    $enumString = json_encode($cases, JSON_PRETTY_PRINT);
-    $content = "export const $enumName = $enumString as const;".
-        "\n\n export type $enumName = typeof $enumName;";
-    file_put_contents("$dir/$enumName.ts", $content);
-}
+<?php
+
+use App\Contracts\Enums\PublicEnumInterface;
+
+require_once __DIR__."/../../../../vendor/autoload.php";
+
+$dir = __DIR__."/models";
+if (!is_dir($dir)) {
+    mkdir($dir);
+}
+foreach (\App\Enums\Router\PublicEnumEnum::cases() as $publicEnum) {
+    $ref = new ReflectionEnum($publicEnum->value);
+    $cases = [];
+    foreach ($ref->getCases() as $c) {
+        /** @var BackedEnum $enum */
+        $enum = $c->getEnum()->getName();
+        $value = $c->getBackingValue();
+        /** @var PublicEnumInterface $case */
+        $case = $enum::from($value);
+        $cases[$c->getName()] = [
+            "name" => $case->name,
+            "value" => $case->value,
+            "publicValue" => $case->getPublicValue()
+        ];
+    }
+    $enumName = $ref->getShortName();
+    $enumString = json_encode($cases, JSON_PRETTY_PRINT);
+    $content = "export const $enumName = $enumString as const;".
+        "\n\n export type $enumName = typeof $enumName;";
+    file_put_contents("$dir/$enumName.ts", $content);
+}

package/index.ts

@@ -2,7 +2,7 @@
 /* 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:    `https://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ * 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:   `https://bitbucket.org`               For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 

package/models/PortStatusEnum.ts

@@ -13,6 +13,11 @@ export const PortStatusEnum = {
         "name": "CLOSED",
         "value": 2,
         "publicValue": "Closed"
+    },
+    "CANCELLED": {
+        "name": "CANCELLED",
+        "value": 3,
+        "publicValue": "Cancelled"
     }
 } as const;
 

package/openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "7.14.0"
+    "version": "7.21.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.85-dev.0",
+  "version": "3.2.85",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {
@@ -22,7 +22,7 @@
     "prepare": "npm run build"
   },
   "dependencies": {
-    "axios": "^1.6.1"
+    "axios": "^1.13.5"
   },
   "devDependencies": {
     "@types/node": "12.11.5 - 12.20.42",

package/docs/NumberPortModel.md

@@ -1,51 +0,0 @@
-# NumberPortModel
-
-Number Port Model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**endUser** | **string** | End User | [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]
-**postCode** | **string** | Post Code | [optional] [default to undefined]
-**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
-**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
-**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
-**portDate** | **string** | Port Date | [optional] [default to undefined]
-**comment** | **string** | Comment | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
-**ranges** | **Array<any>** | Number Port Ranges | [optional] [default to undefined]
-**customerName** | **string** | Customer Company Name | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortModel } from 'yellowgrid-api-ts';
-
-const instance: NumberPortModel = {
-    id,
-    customerId,
-    endUser,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    portDate,
-    comment,
-    status,
-    ticketId,
-    ranges,
-    customerName,
-};
-```
-
-[[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/TelephonySupportTicketModel.md

@@ -1,41 +0,0 @@
-# TelephonySupportTicketModel
-
-Telephony Support Ticket
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Ticket ID | [optional] [default to undefined]
-**status** | **string** | Ticket status | [optional] [default to undefined]
-**statusId** | **number** | Ticket status ID | [optional] [default to undefined]
-**subject** | **string** | Ticket subject | [optional] [default to undefined]
-**supportEmail** | **string** | Support email address | [optional] [default to undefined]
-**toEmails** | **Array<string>** | Recipient emails | [optional] [default to undefined]
-**description** | **string** | Ticket description (HTML) | [optional] [default to undefined]
-**descriptionText** | **string** | Ticket description (plain text) | [optional] [default to undefined]
-**createdAt** | **string** | Creation timestamp | [optional] [default to undefined]
-**attachments** | [**Array<AttachmentModel>**](AttachmentModel.md) | Attachments | [optional] [default to undefined]
-**conversations** | [**Array<ConversationModel>**](ConversationModel.md) | Conversations | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { TelephonySupportTicketModel } from 'yellowgrid-api-ts';
-
-const instance: TelephonySupportTicketModel = {
-    id,
-    status,
-    statusId,
-    subject,
-    supportEmail,
-    toEmails,
-    description,
-    descriptionText,
-    createdAt,
-    attachments,
-    conversations,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)