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

package/docs/{CreditNoteModel.md → NumberPortNoteDTO.md}

@@ -1,27 +1,27 @@
-# CreditNoteModel
+# NumberPortNoteDTO
 
-Credit Note Model
+Number Port Note DTO
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **number** | id | [optional] [default to undefined]
-**orderId** | **number** | orderId | [optional] [default to undefined]
-**transactionId** | **string** | transactionId | [optional] [default to undefined]
-**amount** | **number** | amount | [optional] [default to undefined]
+**portId** | **number** | portId | [optional] [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
+**user** | **string** | user | [optional] [default to undefined]
 **timestamp** | **string** | timestamp | [optional] [default to undefined]
 
 ## Example
 
 ```typescript
-import { CreditNoteModel } from 'yellowgrid-api-ts';
+import { NumberPortNoteDTO } from 'yellowgrid-api-ts';
 
-const instance: CreditNoteModel = {
+const instance: NumberPortNoteDTO = {
     id,
-    orderId,
-    transactionId,
-    amount,
+    portId,
+    note,
+    user,
     timestamp,
 };
 ```

package/docs/NumberPortingApi.md

@@ -1,6 +1,6 @@
 # NumberPortingApi
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -10,6 +10,7 @@ All URIs are relative to *https://api.yellowgrid.local*
 |[**getGetAdminNumberPorts**](#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | |
 |[**getUpdateNumberPort**](#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | |
 |[**patchCloseAdminNumberPort**](#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | |
+|[**postAddAdminNote**](#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | |
 |[**postCreateNumberPort**](#postcreatenumberport) | **POST** /sip/numbers/ports | |
 |[**postSubmitNumberPort**](#postsubmitnumberport) | **POST** /sip/numbers/ports/{id}/submit | |
 |[**postUpdateNumberPort**](#postupdatenumberport) | **POST** /sip/numbers/ports/{id} | |
@@ -128,7 +129,7 @@ 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)
 
 # **getGetAdminNumberPort**
-> NumberPortDTO getGetAdminNumberPort()
+> AdminNumberPortDTO getGetAdminNumberPort()
 
 
 ### Example
@@ -158,7 +159,7 @@ const { status, data } = await apiInstance.getGetAdminNumberPort(
 
 ### Return type
 
-**NumberPortDTO**
+**AdminNumberPortDTO**
 
 ### Authorization
 
@@ -293,7 +294,7 @@ 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)
 
 # **patchCloseAdminNumberPort**
-> NumberPortDTO patchCloseAdminNumberPort()
+> AdminNumberPortDTO patchCloseAdminNumberPort()
 
 
 ### Example
@@ -323,7 +324,7 @@ const { status, data } = await apiInstance.patchCloseAdminNumberPort(
 
 ### Return type
 
-**NumberPortDTO**
+**AdminNumberPortDTO**
 
 ### Authorization
 
@@ -345,6 +346,63 @@ 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)
 
+# **postAddAdminNote**
+> AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
+
+
+### Example
+
+```typescript
+import {
+    NumberPortingApi,
+    Configuration,
+    PostAddAdminNoteRequest
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new NumberPortingApi(configuration);
+
+let id: number; //Number Port ID (default to undefined)
+let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
+
+const { status, data } = await apiInstance.postAddAdminNote(
+    id,
+    postAddAdminNoteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**|  | |
+| **id** | [**number**] | Number Port ID | defaults to undefined|
+
+
+### Return type
+
+**AdminNumberPortDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Admin Number Port |  -  |
+|**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)
+
 # **postCreateNumberPort**
 > NumberPortDTO postCreateNumberPort()
 
@@ -610,7 +668,7 @@ 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)
 
 # **putGetAdminNumberPort**
-> NumberPortDTO putGetAdminNumberPort(numberPortDTO)
+> AdminNumberPortDTO putGetAdminNumberPort(numberPortDTO)
 
 
 ### Example
@@ -644,7 +702,7 @@ const { status, data } = await apiInstance.putGetAdminNumberPort(
 
 ### Return type
 
-**NumberPortDTO**
+**AdminNumberPortDTO**
 
 ### Authorization
 

package/docs/OAuth20Api.md

@@ -1,6 +1,6 @@
 # OAuth20Api
 
-All URIs are relative to *https://api.yellowgrid.local*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -157,7 +157,7 @@ const { status, data } = await apiInstance.postAccessToken(
 | **clientId** | [**string**] | OAuth 2.0 Client ID | (optional) defaults to undefined|
 | **clientSecret** | [**string**] | OAuth 2.0 Client Secret | (optional) defaults to undefined|
 | **grantType** | [**string**]**Array<&#39;client_credentials&#39; &#124; &#39;code&#39; &#124; &#39;refresh_token&#39; &#124; &#39;authorization_code&#39; &#124; &#39;ms_auth&#39; &#124; &#39;token_exchange&#39; &#124; &#39;password&#39;>** | OAuth 2.0 Grant Type | (optional) defaults to undefined|
-| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
+| **scope** | [**string**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;sms.read&#39; &#124; &#39;sms.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | (optional) defaults to undefined|
 | **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
 | **code** | [**string**] | OAuth 2.0 Auth Code | (optional) defaults to undefined|
 | **refreshToken** | [**string**] | OAuth 2.0 Refresh Token | (optional) defaults to undefined|
@@ -210,7 +210,7 @@ const apiInstance = new OAuth20Api(configuration);
 
 let clientId: string; //OAuth 2.0 Client ID (default to undefined)
 let responseType: string; //OAuth 2.0 Response Type (default to 'code')
-let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
+let scope: '*' | 'fdps' | 'scope' | 'portal' | 'tcx_wizard' | 'accounts.read' | 'accounts.write' | 'number_porting.read' | 'number_porting.write' | 'pricing.read' | 'orders.read' | 'orders.write' | 'products.read' | 'provisioning.read' | 'provisioning.write' | 'sms.read' | 'sms.write' | 'trunks.read' | 'trunks.write' | 'tcx_integrations.read' | 'tcx_integrations.write' | 'tcx_licence_details.read' | 'tcx_installations.read' | 'tcx_installations.write' | 'tcx_mt.read' | 'tcx_mt.write' | 'tickets.read' | 'tickets.write'; //OAuth 2.0 Scope (default to undefined)
 let redirectUri: string; //OAuth 2.0 Redirect URI (optional) (default to undefined)
 let state: string; //OAuth 2.0 State (optional) (default to undefined)
 let codeChallenge: string; //OAuth 2.0 Code Challenge (optional) (default to undefined)
@@ -233,7 +233,7 @@ const { status, data } = await apiInstance.postAuthorise(
 |------------- | ------------- | ------------- | -------------|
 | **clientId** | [**string**] | OAuth 2.0 Client ID | defaults to undefined|
 | **responseType** | [**string**] | OAuth 2.0 Response Type | defaults to 'code'|
-| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;number_porting.read&#39; | &#39;number_porting.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
+| **scope** | [**&#39;*&#39; | &#39;fdps&#39; | &#39;scope&#39; | &#39;portal&#39; | &#39;tcx_wizard&#39; | &#39;accounts.read&#39; | &#39;accounts.write&#39; | &#39;number_porting.read&#39; | &#39;number_porting.write&#39; | &#39;pricing.read&#39; | &#39;orders.read&#39; | &#39;orders.write&#39; | &#39;products.read&#39; | &#39;provisioning.read&#39; | &#39;provisioning.write&#39; | &#39;sms.read&#39; | &#39;sms.write&#39; | &#39;trunks.read&#39; | &#39;trunks.write&#39; | &#39;tcx_integrations.read&#39; | &#39;tcx_integrations.write&#39; | &#39;tcx_licence_details.read&#39; | &#39;tcx_installations.read&#39; | &#39;tcx_installations.write&#39; | &#39;tcx_mt.read&#39; | &#39;tcx_mt.write&#39; | &#39;tickets.read&#39; | &#39;tickets.write&#39;**]**Array<&#39;*&#39; &#124; &#39;fdps&#39; &#124; &#39;scope&#39; &#124; &#39;portal&#39; &#124; &#39;tcx_wizard&#39; &#124; &#39;accounts.read&#39; &#124; &#39;accounts.write&#39; &#124; &#39;number_porting.read&#39; &#124; &#39;number_porting.write&#39; &#124; &#39;pricing.read&#39; &#124; &#39;orders.read&#39; &#124; &#39;orders.write&#39; &#124; &#39;products.read&#39; &#124; &#39;provisioning.read&#39; &#124; &#39;provisioning.write&#39; &#124; &#39;sms.read&#39; &#124; &#39;sms.write&#39; &#124; &#39;trunks.read&#39; &#124; &#39;trunks.write&#39; &#124; &#39;tcx_integrations.read&#39; &#124; &#39;tcx_integrations.write&#39; &#124; &#39;tcx_licence_details.read&#39; &#124; &#39;tcx_installations.read&#39; &#124; &#39;tcx_installations.write&#39; &#124; &#39;tcx_mt.read&#39; &#124; &#39;tcx_mt.write&#39; &#124; &#39;tickets.read&#39; &#124; &#39;tickets.write&#39;>** | OAuth 2.0 Scope | defaults to undefined|
 | **redirectUri** | [**string**] | OAuth 2.0 Redirect URI | (optional) defaults to undefined|
 | **state** | [**string**] | OAuth 2.0 State | (optional) defaults to undefined|
 | **codeChallenge** | [**string**] | OAuth 2.0 Code Challenge | (optional) defaults to undefined|