yellowgrid-api-ts 3.2.120-dev.0 → 3.2.122-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +4 -1
- package/README.md +6 -1
- package/api.ts +307 -20
- package/dist/api.d.ts +215 -14
- package/dist/api.js +207 -18
- package/docs/CRMApi.md +120 -0
- package/docs/CrmActivityDto.md +33 -0
- package/docs/CrmNoteEntity.md +39 -0
- package/docs/CrmNoteModel.md +39 -0
- package/docs/NumberPortingApi.md +5 -5
- package/docs/PostCreateCrmNoteRequest.md +20 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -53,7 +53,10 @@ docs/CreditNoteItemDTO.md
|
|
|
53
53
|
docs/CreditNoteItemEntity.md
|
|
54
54
|
docs/CreditNoteItemModel.md
|
|
55
55
|
docs/CreditNoteModel.md
|
|
56
|
+
docs/CrmActivityDto.md
|
|
56
57
|
docs/CrmContactDTO.md
|
|
58
|
+
docs/CrmNoteEntity.md
|
|
59
|
+
docs/CrmNoteModel.md
|
|
57
60
|
docs/CustomerInformationModel.md
|
|
58
61
|
docs/CustomerItemRequestDTO.md
|
|
59
62
|
docs/CustomerOrderRequestDTO.md
|
|
@@ -128,9 +131,9 @@ docs/PatchUpdateAccountPhoneRequest.md
|
|
|
128
131
|
docs/PatchUpdateAccountVatNumberRequest.md
|
|
129
132
|
docs/PortalAccountModel.md
|
|
130
133
|
docs/PortalLoginModel.md
|
|
131
|
-
docs/PostAddAdminNoteRequest.md
|
|
132
134
|
docs/PostAddOrderNoteRequest.md
|
|
133
135
|
docs/PostAddWebhook200Response.md
|
|
136
|
+
docs/PostCreateCrmNoteRequest.md
|
|
134
137
|
docs/PostGetClientCredentialsRequest.md
|
|
135
138
|
docs/PostGetProductForCustomerRequest.md
|
|
136
139
|
docs/PostGetProductRequest.md
|
package/README.md
CHANGED
|
@@ -80,7 +80,9 @@ Class | Method | HTTP request | Description
|
|
|
80
80
|
*AccountsApi* | [**putUpdateAccountContact**](docs/AccountsApi.md#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact
|
|
81
81
|
*AccountsApi* | [**putUpdateBillingAddress**](docs/AccountsApi.md#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address |
|
|
82
82
|
*AccountsApi* | [**putUpdateShippingAddress**](docs/AccountsApi.md#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address |
|
|
83
|
+
*CRMApi* | [**getGetCrmActivities**](docs/CRMApi.md#getgetcrmactivities) | **GET** /admin/crm/{id}/activities |
|
|
83
84
|
*CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search |
|
|
85
|
+
*CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note |
|
|
84
86
|
*Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
|
|
85
87
|
*Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
|
|
86
88
|
*Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
|
|
@@ -328,7 +330,10 @@ Class | Method | HTTP request | Description
|
|
|
328
330
|
- [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
|
|
329
331
|
- [CreditNoteItemModel](docs/CreditNoteItemModel.md)
|
|
330
332
|
- [CreditNoteModel](docs/CreditNoteModel.md)
|
|
333
|
+
- [CrmActivityDto](docs/CrmActivityDto.md)
|
|
331
334
|
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
335
|
+
- [CrmNoteEntity](docs/CrmNoteEntity.md)
|
|
336
|
+
- [CrmNoteModel](docs/CrmNoteModel.md)
|
|
332
337
|
- [CustomerInformationModel](docs/CustomerInformationModel.md)
|
|
333
338
|
- [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
|
|
334
339
|
- [CustomerOrderRequestDTO](docs/CustomerOrderRequestDTO.md)
|
|
@@ -399,9 +404,9 @@ Class | Method | HTTP request | Description
|
|
|
399
404
|
- [PatchUpdateAccountVatNumberRequest](docs/PatchUpdateAccountVatNumberRequest.md)
|
|
400
405
|
- [PortalAccountModel](docs/PortalAccountModel.md)
|
|
401
406
|
- [PortalLoginModel](docs/PortalLoginModel.md)
|
|
402
|
-
- [PostAddAdminNoteRequest](docs/PostAddAdminNoteRequest.md)
|
|
403
407
|
- [PostAddOrderNoteRequest](docs/PostAddOrderNoteRequest.md)
|
|
404
408
|
- [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
|
|
409
|
+
- [PostCreateCrmNoteRequest](docs/PostCreateCrmNoteRequest.md)
|
|
405
410
|
- [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
|
|
406
411
|
- [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
|
|
407
412
|
- [PostGetProductRequest](docs/PostGetProductRequest.md)
|
package/api.ts
CHANGED
|
@@ -895,6 +895,7 @@ export const AuditLogEntityTypeEnum = {
|
|
|
895
895
|
ApiLog: 'api_log',
|
|
896
896
|
PopsBatches: 'pops_batches',
|
|
897
897
|
PopsCourierPrices: 'pops_courier_prices',
|
|
898
|
+
PopsCrmNotes: 'pops_crm_notes',
|
|
898
899
|
PopsCreditAccounts: 'pops_credit_accounts',
|
|
899
900
|
PopsCreditNotes: 'pops_credit_notes',
|
|
900
901
|
PopsCreditNotesItems: 'pops_credit_notes_items',
|
|
@@ -1597,6 +1598,39 @@ export interface CreditNoteModel {
|
|
|
1597
1598
|
*/
|
|
1598
1599
|
'items'?: Array<CreditNoteItemModel>;
|
|
1599
1600
|
}
|
|
1601
|
+
/**
|
|
1602
|
+
* CRM Activity
|
|
1603
|
+
*/
|
|
1604
|
+
export interface CrmActivityDto {
|
|
1605
|
+
/**
|
|
1606
|
+
* Activity Type
|
|
1607
|
+
*/
|
|
1608
|
+
'type'?: string;
|
|
1609
|
+
/**
|
|
1610
|
+
* Date Time
|
|
1611
|
+
*/
|
|
1612
|
+
'timeStamp'?: string | null;
|
|
1613
|
+
/**
|
|
1614
|
+
* Activity Title
|
|
1615
|
+
*/
|
|
1616
|
+
'title'?: string;
|
|
1617
|
+
/**
|
|
1618
|
+
* Activity Description
|
|
1619
|
+
*/
|
|
1620
|
+
'description'?: string;
|
|
1621
|
+
/**
|
|
1622
|
+
* Activity URL
|
|
1623
|
+
*/
|
|
1624
|
+
'url'?: string | null;
|
|
1625
|
+
/**
|
|
1626
|
+
* Activity User Name
|
|
1627
|
+
*/
|
|
1628
|
+
'user'?: string | null;
|
|
1629
|
+
/**
|
|
1630
|
+
* Activity Contact Name
|
|
1631
|
+
*/
|
|
1632
|
+
'contact'?: string | null;
|
|
1633
|
+
}
|
|
1600
1634
|
/**
|
|
1601
1635
|
* CRM Contact
|
|
1602
1636
|
*/
|
|
@@ -1630,6 +1664,96 @@ export interface CrmContactDTO {
|
|
|
1630
1664
|
*/
|
|
1631
1665
|
'url'?: string;
|
|
1632
1666
|
}
|
|
1667
|
+
/**
|
|
1668
|
+
* CrmNotesEntity
|
|
1669
|
+
*/
|
|
1670
|
+
export interface CrmNoteEntity {
|
|
1671
|
+
/**
|
|
1672
|
+
* id
|
|
1673
|
+
*/
|
|
1674
|
+
'id'?: number;
|
|
1675
|
+
/**
|
|
1676
|
+
* customerId
|
|
1677
|
+
*/
|
|
1678
|
+
'customerId'?: string;
|
|
1679
|
+
/**
|
|
1680
|
+
* userId
|
|
1681
|
+
*/
|
|
1682
|
+
'userId'?: number;
|
|
1683
|
+
/**
|
|
1684
|
+
* type
|
|
1685
|
+
*/
|
|
1686
|
+
'type'?: string;
|
|
1687
|
+
/**
|
|
1688
|
+
* note
|
|
1689
|
+
*/
|
|
1690
|
+
'note'?: string;
|
|
1691
|
+
/**
|
|
1692
|
+
* timestamp
|
|
1693
|
+
*/
|
|
1694
|
+
'timestamp'?: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* journalTime
|
|
1697
|
+
*/
|
|
1698
|
+
'journalTime'?: string;
|
|
1699
|
+
/**
|
|
1700
|
+
* duration
|
|
1701
|
+
*/
|
|
1702
|
+
'duration'?: string;
|
|
1703
|
+
/**
|
|
1704
|
+
* callType
|
|
1705
|
+
*/
|
|
1706
|
+
'callType'?: string;
|
|
1707
|
+
/**
|
|
1708
|
+
* callId
|
|
1709
|
+
*/
|
|
1710
|
+
'callId'?: number;
|
|
1711
|
+
}
|
|
1712
|
+
/**
|
|
1713
|
+
* CrmNotesEntity
|
|
1714
|
+
*/
|
|
1715
|
+
export interface CrmNoteModel {
|
|
1716
|
+
/**
|
|
1717
|
+
* id
|
|
1718
|
+
*/
|
|
1719
|
+
'id'?: number;
|
|
1720
|
+
/**
|
|
1721
|
+
* customerId
|
|
1722
|
+
*/
|
|
1723
|
+
'customerId'?: string;
|
|
1724
|
+
/**
|
|
1725
|
+
* userId
|
|
1726
|
+
*/
|
|
1727
|
+
'userId'?: number;
|
|
1728
|
+
/**
|
|
1729
|
+
* type
|
|
1730
|
+
*/
|
|
1731
|
+
'type'?: string;
|
|
1732
|
+
/**
|
|
1733
|
+
* note
|
|
1734
|
+
*/
|
|
1735
|
+
'note'?: string;
|
|
1736
|
+
/**
|
|
1737
|
+
* timestamp
|
|
1738
|
+
*/
|
|
1739
|
+
'timestamp'?: string;
|
|
1740
|
+
/**
|
|
1741
|
+
* journalTime
|
|
1742
|
+
*/
|
|
1743
|
+
'journalTime'?: string;
|
|
1744
|
+
/**
|
|
1745
|
+
* duration
|
|
1746
|
+
*/
|
|
1747
|
+
'duration'?: string;
|
|
1748
|
+
/**
|
|
1749
|
+
* callType
|
|
1750
|
+
*/
|
|
1751
|
+
'callType'?: string;
|
|
1752
|
+
/**
|
|
1753
|
+
* callId
|
|
1754
|
+
*/
|
|
1755
|
+
'callId'?: number;
|
|
1756
|
+
}
|
|
1633
1757
|
/**
|
|
1634
1758
|
* SIP Trunk Customer
|
|
1635
1759
|
*/
|
|
@@ -4140,12 +4264,6 @@ export interface PortalLoginModel {
|
|
|
4140
4264
|
*/
|
|
4141
4265
|
'redirect_uri'?: string;
|
|
4142
4266
|
}
|
|
4143
|
-
export interface PostAddAdminNoteRequest {
|
|
4144
|
-
/**
|
|
4145
|
-
* Note
|
|
4146
|
-
*/
|
|
4147
|
-
'note'?: string;
|
|
4148
|
-
}
|
|
4149
4267
|
export interface PostAddOrderNoteRequest {
|
|
4150
4268
|
/**
|
|
4151
4269
|
* Order Note
|
|
@@ -4155,6 +4273,12 @@ export interface PostAddOrderNoteRequest {
|
|
|
4155
4273
|
export interface PostAddWebhook200Response {
|
|
4156
4274
|
'url'?: string;
|
|
4157
4275
|
}
|
|
4276
|
+
export interface PostCreateCrmNoteRequest {
|
|
4277
|
+
/**
|
|
4278
|
+
* Note
|
|
4279
|
+
*/
|
|
4280
|
+
'note'?: string;
|
|
4281
|
+
}
|
|
4158
4282
|
export interface PostGetClientCredentialsRequest {
|
|
4159
4283
|
/**
|
|
4160
4284
|
* OAuth 2.0 scopes
|
|
@@ -9997,6 +10121,53 @@ export type PatchSetPrizePromoStateEnum = typeof PatchSetPrizePromoStateEnum[key
|
|
|
9997
10121
|
*/
|
|
9998
10122
|
export const CRMApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
9999
10123
|
return {
|
|
10124
|
+
/**
|
|
10125
|
+
* Get Customer CRM Activities
|
|
10126
|
+
* @param {number} id Account ID
|
|
10127
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10128
|
+
* @param {number} userId Activity Created By
|
|
10129
|
+
* @param {*} [options] Override http request option.
|
|
10130
|
+
* @throws {RequiredError}
|
|
10131
|
+
*/
|
|
10132
|
+
getGetCrmActivities: async (id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10133
|
+
// verify required parameter 'id' is not null or undefined
|
|
10134
|
+
assertParamExists('getGetCrmActivities', 'id', id)
|
|
10135
|
+
// verify required parameter 'type' is not null or undefined
|
|
10136
|
+
assertParamExists('getGetCrmActivities', 'type', type)
|
|
10137
|
+
// verify required parameter 'userId' is not null or undefined
|
|
10138
|
+
assertParamExists('getGetCrmActivities', 'userId', userId)
|
|
10139
|
+
const localVarPath = `/admin/crm/{id}/activities`
|
|
10140
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
10141
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10142
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10143
|
+
let baseOptions;
|
|
10144
|
+
if (configuration) {
|
|
10145
|
+
baseOptions = configuration.baseOptions;
|
|
10146
|
+
}
|
|
10147
|
+
|
|
10148
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
10149
|
+
const localVarHeaderParameter = {} as any;
|
|
10150
|
+
const localVarQueryParameter = {} as any;
|
|
10151
|
+
|
|
10152
|
+
if (type !== undefined) {
|
|
10153
|
+
localVarQueryParameter['type'] = type;
|
|
10154
|
+
}
|
|
10155
|
+
|
|
10156
|
+
if (userId !== undefined) {
|
|
10157
|
+
localVarQueryParameter['userId'] = userId;
|
|
10158
|
+
}
|
|
10159
|
+
|
|
10160
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
10161
|
+
|
|
10162
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10163
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10164
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10165
|
+
|
|
10166
|
+
return {
|
|
10167
|
+
url: toPathString(localVarUrlObj),
|
|
10168
|
+
options: localVarRequestOptions,
|
|
10169
|
+
};
|
|
10170
|
+
},
|
|
10000
10171
|
/**
|
|
10001
10172
|
* Search for contacts by phone number
|
|
10002
10173
|
* @param {*} [options] Override http request option.
|
|
@@ -10021,6 +10192,42 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
10021
10192
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10022
10193
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10023
10194
|
|
|
10195
|
+
return {
|
|
10196
|
+
url: toPathString(localVarUrlObj),
|
|
10197
|
+
options: localVarRequestOptions,
|
|
10198
|
+
};
|
|
10199
|
+
},
|
|
10200
|
+
/**
|
|
10201
|
+
* Create CRM Note
|
|
10202
|
+
* @param {number} id Account ID
|
|
10203
|
+
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
10204
|
+
* @param {*} [options] Override http request option.
|
|
10205
|
+
* @throws {RequiredError}
|
|
10206
|
+
*/
|
|
10207
|
+
postCreateCrmNote: async (id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10208
|
+
// verify required parameter 'id' is not null or undefined
|
|
10209
|
+
assertParamExists('postCreateCrmNote', 'id', id)
|
|
10210
|
+
const localVarPath = `/admin/crm/{id}/activities/note`
|
|
10211
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
10212
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
10213
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
10214
|
+
let baseOptions;
|
|
10215
|
+
if (configuration) {
|
|
10216
|
+
baseOptions = configuration.baseOptions;
|
|
10217
|
+
}
|
|
10218
|
+
|
|
10219
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
10220
|
+
const localVarHeaderParameter = {} as any;
|
|
10221
|
+
const localVarQueryParameter = {} as any;
|
|
10222
|
+
|
|
10223
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
10224
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
10225
|
+
|
|
10226
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
10227
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
10228
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
10229
|
+
localVarRequestOptions.data = serializeDataIfNeeded(postCreateCrmNoteRequest, localVarRequestOptions, configuration)
|
|
10230
|
+
|
|
10024
10231
|
return {
|
|
10025
10232
|
url: toPathString(localVarUrlObj),
|
|
10026
10233
|
options: localVarRequestOptions,
|
|
@@ -10035,6 +10242,20 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
10035
10242
|
export const CRMApiFp = function(configuration?: Configuration) {
|
|
10036
10243
|
const localVarAxiosParamCreator = CRMApiAxiosParamCreator(configuration)
|
|
10037
10244
|
return {
|
|
10245
|
+
/**
|
|
10246
|
+
* Get Customer CRM Activities
|
|
10247
|
+
* @param {number} id Account ID
|
|
10248
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10249
|
+
* @param {number} userId Activity Created By
|
|
10250
|
+
* @param {*} [options] Override http request option.
|
|
10251
|
+
* @throws {RequiredError}
|
|
10252
|
+
*/
|
|
10253
|
+
async getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmActivityDto>>> {
|
|
10254
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCrmActivities(id, type, userId, options);
|
|
10255
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10256
|
+
const localVarOperationServerBasePath = operationServerMap['CRMApi.getGetCrmActivities']?.[localVarOperationServerIndex]?.url;
|
|
10257
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10258
|
+
},
|
|
10038
10259
|
/**
|
|
10039
10260
|
* Search for contacts by phone number
|
|
10040
10261
|
* @param {*} [options] Override http request option.
|
|
@@ -10046,6 +10267,19 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
10046
10267
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.getSearchByPhone']?.[localVarOperationServerIndex]?.url;
|
|
10047
10268
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10048
10269
|
},
|
|
10270
|
+
/**
|
|
10271
|
+
* Create CRM Note
|
|
10272
|
+
* @param {number} id Account ID
|
|
10273
|
+
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
10274
|
+
* @param {*} [options] Override http request option.
|
|
10275
|
+
* @throws {RequiredError}
|
|
10276
|
+
*/
|
|
10277
|
+
async postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDto>> {
|
|
10278
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateCrmNote(id, postCreateCrmNoteRequest, options);
|
|
10279
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10280
|
+
const localVarOperationServerBasePath = operationServerMap['CRMApi.postCreateCrmNote']?.[localVarOperationServerIndex]?.url;
|
|
10281
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
10282
|
+
},
|
|
10049
10283
|
}
|
|
10050
10284
|
};
|
|
10051
10285
|
|
|
@@ -10055,6 +10289,17 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
10055
10289
|
export const CRMApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
10056
10290
|
const localVarFp = CRMApiFp(configuration)
|
|
10057
10291
|
return {
|
|
10292
|
+
/**
|
|
10293
|
+
* Get Customer CRM Activities
|
|
10294
|
+
* @param {number} id Account ID
|
|
10295
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10296
|
+
* @param {number} userId Activity Created By
|
|
10297
|
+
* @param {*} [options] Override http request option.
|
|
10298
|
+
* @throws {RequiredError}
|
|
10299
|
+
*/
|
|
10300
|
+
getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmActivityDto>> {
|
|
10301
|
+
return localVarFp.getGetCrmActivities(id, type, userId, options).then((request) => request(axios, basePath));
|
|
10302
|
+
},
|
|
10058
10303
|
/**
|
|
10059
10304
|
* Search for contacts by phone number
|
|
10060
10305
|
* @param {*} [options] Override http request option.
|
|
@@ -10063,6 +10308,16 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10063
10308
|
getSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
|
|
10064
10309
|
return localVarFp.getSearchByPhone(options).then((request) => request(axios, basePath));
|
|
10065
10310
|
},
|
|
10311
|
+
/**
|
|
10312
|
+
* Create CRM Note
|
|
10313
|
+
* @param {number} id Account ID
|
|
10314
|
+
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
10315
|
+
* @param {*} [options] Override http request option.
|
|
10316
|
+
* @throws {RequiredError}
|
|
10317
|
+
*/
|
|
10318
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDto> {
|
|
10319
|
+
return localVarFp.postCreateCrmNote(id, postCreateCrmNoteRequest, options).then((request) => request(axios, basePath));
|
|
10320
|
+
},
|
|
10066
10321
|
};
|
|
10067
10322
|
};
|
|
10068
10323
|
|
|
@@ -10070,6 +10325,18 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10070
10325
|
* CRMApi - object-oriented interface
|
|
10071
10326
|
*/
|
|
10072
10327
|
export class CRMApi extends BaseAPI {
|
|
10328
|
+
/**
|
|
10329
|
+
* Get Customer CRM Activities
|
|
10330
|
+
* @param {number} id Account ID
|
|
10331
|
+
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10332
|
+
* @param {number} userId Activity Created By
|
|
10333
|
+
* @param {*} [options] Override http request option.
|
|
10334
|
+
* @throws {RequiredError}
|
|
10335
|
+
*/
|
|
10336
|
+
public getGetCrmActivities(id: number, type: GetGetCrmActivitiesTypeEnum, userId: number, options?: RawAxiosRequestConfig) {
|
|
10337
|
+
return CRMApiFp(this.configuration).getGetCrmActivities(id, type, userId, options).then((request) => request(this.axios, this.basePath));
|
|
10338
|
+
}
|
|
10339
|
+
|
|
10073
10340
|
/**
|
|
10074
10341
|
* Search for contacts by phone number
|
|
10075
10342
|
* @param {*} [options] Override http request option.
|
|
@@ -10078,8 +10345,28 @@ export class CRMApi extends BaseAPI {
|
|
|
10078
10345
|
public getSearchByPhone(options?: RawAxiosRequestConfig) {
|
|
10079
10346
|
return CRMApiFp(this.configuration).getSearchByPhone(options).then((request) => request(this.axios, this.basePath));
|
|
10080
10347
|
}
|
|
10348
|
+
|
|
10349
|
+
/**
|
|
10350
|
+
* Create CRM Note
|
|
10351
|
+
* @param {number} id Account ID
|
|
10352
|
+
* @param {PostCreateCrmNoteRequest} [postCreateCrmNoteRequest] CRM Note Request
|
|
10353
|
+
* @param {*} [options] Override http request option.
|
|
10354
|
+
* @throws {RequiredError}
|
|
10355
|
+
*/
|
|
10356
|
+
public postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) {
|
|
10357
|
+
return CRMApiFp(this.configuration).postCreateCrmNote(id, postCreateCrmNoteRequest, options).then((request) => request(this.axios, this.basePath));
|
|
10358
|
+
}
|
|
10081
10359
|
}
|
|
10082
10360
|
|
|
10361
|
+
export const GetGetCrmActivitiesTypeEnum = {
|
|
10362
|
+
Alert: 'alert',
|
|
10363
|
+
Call: 'call',
|
|
10364
|
+
Note: 'note',
|
|
10365
|
+
Order: 'order',
|
|
10366
|
+
Quote: 'quote',
|
|
10367
|
+
TcxOrder: 'tcx_order'
|
|
10368
|
+
} as const;
|
|
10369
|
+
export type GetGetCrmActivitiesTypeEnum = typeof GetGetCrmActivitiesTypeEnum[keyof typeof GetGetCrmActivitiesTypeEnum];
|
|
10083
10370
|
|
|
10084
10371
|
|
|
10085
10372
|
/**
|
|
@@ -15544,15 +15831,15 @@ export const NumberPortingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
15544
15831
|
/**
|
|
15545
15832
|
*
|
|
15546
15833
|
* @param {number} id Number Port ID
|
|
15547
|
-
* @param {
|
|
15834
|
+
* @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
|
|
15548
15835
|
* @param {*} [options] Override http request option.
|
|
15549
15836
|
* @throws {RequiredError}
|
|
15550
15837
|
*/
|
|
15551
|
-
postAddAdminNote: async (id: number,
|
|
15838
|
+
postAddAdminNote: async (id: number, postCreateCrmNoteRequest: PostCreateCrmNoteRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
15552
15839
|
// verify required parameter 'id' is not null or undefined
|
|
15553
15840
|
assertParamExists('postAddAdminNote', 'id', id)
|
|
15554
|
-
// verify required parameter '
|
|
15555
|
-
assertParamExists('postAddAdminNote', '
|
|
15841
|
+
// verify required parameter 'postCreateCrmNoteRequest' is not null or undefined
|
|
15842
|
+
assertParamExists('postAddAdminNote', 'postCreateCrmNoteRequest', postCreateCrmNoteRequest)
|
|
15556
15843
|
const localVarPath = `/admin/sip/numbers/ports/{id}/notes`
|
|
15557
15844
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
15558
15845
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -15572,7 +15859,7 @@ export const NumberPortingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
15572
15859
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
15573
15860
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
15574
15861
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
15575
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
15862
|
+
localVarRequestOptions.data = serializeDataIfNeeded(postCreateCrmNoteRequest, localVarRequestOptions, configuration)
|
|
15576
15863
|
|
|
15577
15864
|
return {
|
|
15578
15865
|
url: toPathString(localVarUrlObj),
|
|
@@ -16001,12 +16288,12 @@ export const NumberPortingApiFp = function(configuration?: Configuration) {
|
|
|
16001
16288
|
/**
|
|
16002
16289
|
*
|
|
16003
16290
|
* @param {number} id Number Port ID
|
|
16004
|
-
* @param {
|
|
16291
|
+
* @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
|
|
16005
16292
|
* @param {*} [options] Override http request option.
|
|
16006
16293
|
* @throws {RequiredError}
|
|
16007
16294
|
*/
|
|
16008
|
-
async postAddAdminNote(id: number,
|
|
16009
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postAddAdminNote(id,
|
|
16295
|
+
async postAddAdminNote(id: number, postCreateCrmNoteRequest: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>> {
|
|
16296
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postAddAdminNote(id, postCreateCrmNoteRequest, options);
|
|
16010
16297
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
16011
16298
|
const localVarOperationServerBasePath = operationServerMap['NumberPortingApi.postAddAdminNote']?.[localVarOperationServerIndex]?.url;
|
|
16012
16299
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -16174,12 +16461,12 @@ export const NumberPortingApiFactory = function (configuration?: Configuration,
|
|
|
16174
16461
|
/**
|
|
16175
16462
|
*
|
|
16176
16463
|
* @param {number} id Number Port ID
|
|
16177
|
-
* @param {
|
|
16464
|
+
* @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
|
|
16178
16465
|
* @param {*} [options] Override http request option.
|
|
16179
16466
|
* @throws {RequiredError}
|
|
16180
16467
|
*/
|
|
16181
|
-
postAddAdminNote(id: number,
|
|
16182
|
-
return localVarFp.postAddAdminNote(id,
|
|
16468
|
+
postAddAdminNote(id: number, postCreateCrmNoteRequest: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO> {
|
|
16469
|
+
return localVarFp.postAddAdminNote(id, postCreateCrmNoteRequest, options).then((request) => request(axios, basePath));
|
|
16183
16470
|
},
|
|
16184
16471
|
/**
|
|
16185
16472
|
*
|
|
@@ -16337,12 +16624,12 @@ export class NumberPortingApi extends BaseAPI {
|
|
|
16337
16624
|
/**
|
|
16338
16625
|
*
|
|
16339
16626
|
* @param {number} id Number Port ID
|
|
16340
|
-
* @param {
|
|
16627
|
+
* @param {PostCreateCrmNoteRequest} postCreateCrmNoteRequest
|
|
16341
16628
|
* @param {*} [options] Override http request option.
|
|
16342
16629
|
* @throws {RequiredError}
|
|
16343
16630
|
*/
|
|
16344
|
-
public postAddAdminNote(id: number,
|
|
16345
|
-
return NumberPortingApiFp(this.configuration).postAddAdminNote(id,
|
|
16631
|
+
public postAddAdminNote(id: number, postCreateCrmNoteRequest: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig) {
|
|
16632
|
+
return NumberPortingApiFp(this.configuration).postAddAdminNote(id, postCreateCrmNoteRequest, options).then((request) => request(this.axios, this.basePath));
|
|
16346
16633
|
}
|
|
16347
16634
|
|
|
16348
16635
|
/**
|