yellowgrid-api-ts 3.2.296 → 3.2.298
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 +2 -0
- package/README.md +3 -0
- package/api.ts +129 -7
- package/dist/api.d.ts +91 -4
- package/dist/api.js +87 -10
- package/docs/CRMApi.md +48 -0
- package/docs/CallJournalRequestModel.md +35 -0
- package/docs/CrmActivityDTO.md +8 -0
- package/docs/PatchApproveRmaRequest.md +20 -0
- package/docs/RMAApi.md +7 -3
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -50,6 +50,7 @@ docs/Bundle.md
|
|
|
50
50
|
docs/BundleCustomer.md
|
|
51
51
|
docs/CRMApi.md
|
|
52
52
|
docs/CallBarringModel.md
|
|
53
|
+
docs/CallJournalRequestModel.md
|
|
53
54
|
docs/CallTariff.md
|
|
54
55
|
docs/CallTariffPlan.md
|
|
55
56
|
docs/CallTariffResponse.md
|
|
@@ -182,6 +183,7 @@ docs/OutboundCli.md
|
|
|
182
183
|
docs/PartnerDTO.md
|
|
183
184
|
docs/PasswordSenderDTO.md
|
|
184
185
|
docs/PasswordSenderEntity.md
|
|
186
|
+
docs/PatchApproveRmaRequest.md
|
|
185
187
|
docs/PatchUpdateAccountCnameRequest.md
|
|
186
188
|
docs/PatchUpdateAccountCompanyNumberRequest.md
|
|
187
189
|
docs/PatchUpdateAccountContactPasswordRequest.md
|
package/README.md
CHANGED
|
@@ -178,6 +178,7 @@ Class | Method | HTTP request | Description
|
|
|
178
178
|
*CRMApi* | [**getGetCrmActivities**](docs/CRMApi.md#getgetcrmactivities) | **GET** /admin/crm/{id}/activities |
|
|
179
179
|
*CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search |
|
|
180
180
|
*CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note |
|
|
181
|
+
*CRMApi* | [**postSearchByPhone**](docs/CRMApi.md#postsearchbyphone) | **POST** /crm/contact/search |
|
|
181
182
|
*Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
|
|
182
183
|
*Class3CXApi* | [**getGetTcxCreditStatus**](docs/Class3CXApi.md#getgettcxcreditstatus) | **GET** /tcx/admin/credit | Get 3CX Credit Status
|
|
183
184
|
*Class3CXApi* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring | Get 3CX Expiring Keys
|
|
@@ -491,6 +492,7 @@ Class | Method | HTTP request | Description
|
|
|
491
492
|
- [Bundle](docs/Bundle.md)
|
|
492
493
|
- [BundleCustomer](docs/BundleCustomer.md)
|
|
493
494
|
- [CallBarringModel](docs/CallBarringModel.md)
|
|
495
|
+
- [CallJournalRequestModel](docs/CallJournalRequestModel.md)
|
|
494
496
|
- [CallTariff](docs/CallTariff.md)
|
|
495
497
|
- [CallTariffPlan](docs/CallTariffPlan.md)
|
|
496
498
|
- [CallTariffResponse](docs/CallTariffResponse.md)
|
|
@@ -613,6 +615,7 @@ Class | Method | HTTP request | Description
|
|
|
613
615
|
- [PartnerDTO](docs/PartnerDTO.md)
|
|
614
616
|
- [PasswordSenderDTO](docs/PasswordSenderDTO.md)
|
|
615
617
|
- [PasswordSenderEntity](docs/PasswordSenderEntity.md)
|
|
618
|
+
- [PatchApproveRmaRequest](docs/PatchApproveRmaRequest.md)
|
|
616
619
|
- [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
|
|
617
620
|
- [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
|
|
618
621
|
- [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
|
package/api.ts
CHANGED
|
@@ -1736,6 +1736,43 @@ export interface CallBarringModel {
|
|
|
1736
1736
|
*/
|
|
1737
1737
|
'block087Calls': boolean;
|
|
1738
1738
|
}
|
|
1739
|
+
/**
|
|
1740
|
+
* Call Journal Request Model
|
|
1741
|
+
*/
|
|
1742
|
+
export interface CallJournalRequestModel {
|
|
1743
|
+
/**
|
|
1744
|
+
* User Email
|
|
1745
|
+
*/
|
|
1746
|
+
'userEmail': string;
|
|
1747
|
+
/**
|
|
1748
|
+
* Call Note
|
|
1749
|
+
*/
|
|
1750
|
+
'note': string;
|
|
1751
|
+
/**
|
|
1752
|
+
* Call Timestamp
|
|
1753
|
+
*/
|
|
1754
|
+
'timestamp': string;
|
|
1755
|
+
/**
|
|
1756
|
+
* Call Duration
|
|
1757
|
+
*/
|
|
1758
|
+
'duration': string;
|
|
1759
|
+
/**
|
|
1760
|
+
* Call Recording URL
|
|
1761
|
+
*/
|
|
1762
|
+
'recordingUrl': string;
|
|
1763
|
+
/**
|
|
1764
|
+
* Call Transcription
|
|
1765
|
+
*/
|
|
1766
|
+
'transcription': string;
|
|
1767
|
+
/**
|
|
1768
|
+
* Call Summary
|
|
1769
|
+
*/
|
|
1770
|
+
'summary': string;
|
|
1771
|
+
/**
|
|
1772
|
+
* Call Sentiment
|
|
1773
|
+
*/
|
|
1774
|
+
'sentiment': number;
|
|
1775
|
+
}
|
|
1739
1776
|
export interface CallTariff {
|
|
1740
1777
|
'createdDate'?: string;
|
|
1741
1778
|
'id'?: number;
|
|
@@ -2387,6 +2424,22 @@ export interface CrmActivityDTO {
|
|
|
2387
2424
|
* Activity Order ID
|
|
2388
2425
|
*/
|
|
2389
2426
|
'orderId'?: number | null;
|
|
2427
|
+
/**
|
|
2428
|
+
* Call Recording URL
|
|
2429
|
+
*/
|
|
2430
|
+
'recordingUrl'?: string | null;
|
|
2431
|
+
/**
|
|
2432
|
+
* Call Transcription
|
|
2433
|
+
*/
|
|
2434
|
+
'transcription'?: string | null;
|
|
2435
|
+
/**
|
|
2436
|
+
* Call Summary
|
|
2437
|
+
*/
|
|
2438
|
+
'summary'?: string | null;
|
|
2439
|
+
/**
|
|
2440
|
+
* Call Sentiment
|
|
2441
|
+
*/
|
|
2442
|
+
'sentiment'?: number | null;
|
|
2390
2443
|
}
|
|
2391
2444
|
/**
|
|
2392
2445
|
* CRM Contact
|
|
@@ -5504,6 +5557,12 @@ export interface PasswordSenderEntity {
|
|
|
5504
5557
|
*/
|
|
5505
5558
|
'description': string;
|
|
5506
5559
|
}
|
|
5560
|
+
export interface PatchApproveRmaRequest {
|
|
5561
|
+
/**
|
|
5562
|
+
* Send email to customer
|
|
5563
|
+
*/
|
|
5564
|
+
'sendEmail'?: boolean;
|
|
5565
|
+
}
|
|
5507
5566
|
export interface PatchUpdateAccountCnameRequest {
|
|
5508
5567
|
/**
|
|
5509
5568
|
* CNAME
|
|
@@ -20015,6 +20074,35 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
20015
20074
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20016
20075
|
localVarRequestOptions.data = serializeDataIfNeeded(createCrmNoteBody, localVarRequestOptions, configuration)
|
|
20017
20076
|
|
|
20077
|
+
return {
|
|
20078
|
+
url: toPathString(localVarUrlObj),
|
|
20079
|
+
options: localVarRequestOptions,
|
|
20080
|
+
};
|
|
20081
|
+
},
|
|
20082
|
+
/**
|
|
20083
|
+
* Search for contacts by phone number
|
|
20084
|
+
* @param {*} [options] Override http request option.
|
|
20085
|
+
* @throws {RequiredError}
|
|
20086
|
+
*/
|
|
20087
|
+
postSearchByPhone: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20088
|
+
const localVarPath = `/crm/contact/search`;
|
|
20089
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20090
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20091
|
+
let baseOptions;
|
|
20092
|
+
if (configuration) {
|
|
20093
|
+
baseOptions = configuration.baseOptions;
|
|
20094
|
+
}
|
|
20095
|
+
|
|
20096
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
20097
|
+
const localVarHeaderParameter = {} as any;
|
|
20098
|
+
const localVarQueryParameter = {} as any;
|
|
20099
|
+
|
|
20100
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20101
|
+
|
|
20102
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20103
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20104
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20105
|
+
|
|
20018
20106
|
return {
|
|
20019
20107
|
url: toPathString(localVarUrlObj),
|
|
20020
20108
|
options: localVarRequestOptions,
|
|
@@ -20067,6 +20155,17 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
20067
20155
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.postCreateCrmNote']?.[localVarOperationServerIndex]?.url;
|
|
20068
20156
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20069
20157
|
},
|
|
20158
|
+
/**
|
|
20159
|
+
* Search for contacts by phone number
|
|
20160
|
+
* @param {*} [options] Override http request option.
|
|
20161
|
+
* @throws {RequiredError}
|
|
20162
|
+
*/
|
|
20163
|
+
async postSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>> {
|
|
20164
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postSearchByPhone(options);
|
|
20165
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
20166
|
+
const localVarOperationServerBasePath = operationServerMap['CRMApi.postSearchByPhone']?.[localVarOperationServerIndex]?.url;
|
|
20167
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
20168
|
+
},
|
|
20070
20169
|
}
|
|
20071
20170
|
};
|
|
20072
20171
|
|
|
@@ -20105,6 +20204,14 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
20105
20204
|
postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO> {
|
|
20106
20205
|
return localVarFp.postCreateCrmNote(id, createCrmNoteBody, options).then((request) => request(axios, basePath));
|
|
20107
20206
|
},
|
|
20207
|
+
/**
|
|
20208
|
+
* Search for contacts by phone number
|
|
20209
|
+
* @param {*} [options] Override http request option.
|
|
20210
|
+
* @throws {RequiredError}
|
|
20211
|
+
*/
|
|
20212
|
+
postSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO> {
|
|
20213
|
+
return localVarFp.postSearchByPhone(options).then((request) => request(axios, basePath));
|
|
20214
|
+
},
|
|
20108
20215
|
};
|
|
20109
20216
|
};
|
|
20110
20217
|
|
|
@@ -20143,6 +20250,15 @@ export class CRMApi extends BaseAPI {
|
|
|
20143
20250
|
public postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig) {
|
|
20144
20251
|
return CRMApiFp(this.configuration).postCreateCrmNote(id, createCrmNoteBody, options).then((request) => request(this.axios, this.basePath));
|
|
20145
20252
|
}
|
|
20253
|
+
|
|
20254
|
+
/**
|
|
20255
|
+
* Search for contacts by phone number
|
|
20256
|
+
* @param {*} [options] Override http request option.
|
|
20257
|
+
* @throws {RequiredError}
|
|
20258
|
+
*/
|
|
20259
|
+
public postSearchByPhone(options?: RawAxiosRequestConfig) {
|
|
20260
|
+
return CRMApiFp(this.configuration).postSearchByPhone(options).then((request) => request(this.axios, this.basePath));
|
|
20261
|
+
}
|
|
20146
20262
|
}
|
|
20147
20263
|
|
|
20148
20264
|
export const GetGetCrmActivitiesTypeEnum = {
|
|
@@ -33658,10 +33774,11 @@ export const RMAApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
33658
33774
|
/**
|
|
33659
33775
|
* Approve an RMA
|
|
33660
33776
|
* @param {number} id
|
|
33777
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
33661
33778
|
* @param {*} [options] Override http request option.
|
|
33662
33779
|
* @throws {RequiredError}
|
|
33663
33780
|
*/
|
|
33664
|
-
patchApproveRma: async (id: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33781
|
+
patchApproveRma: async (id: number, patchApproveRmaRequest?: PatchApproveRmaRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
33665
33782
|
// verify required parameter 'id' is not null or undefined
|
|
33666
33783
|
assertParamExists('patchApproveRma', 'id', id)
|
|
33667
33784
|
const localVarPath = `/admin/rma/{id}/approve`
|
|
@@ -33677,10 +33794,12 @@ export const RMAApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
33677
33794
|
const localVarHeaderParameter = {} as any;
|
|
33678
33795
|
const localVarQueryParameter = {} as any;
|
|
33679
33796
|
|
|
33797
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
33680
33798
|
|
|
33681
33799
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33682
33800
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33683
33801
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
33802
|
+
localVarRequestOptions.data = serializeDataIfNeeded(patchApproveRmaRequest, localVarRequestOptions, configuration)
|
|
33684
33803
|
|
|
33685
33804
|
return {
|
|
33686
33805
|
url: toPathString(localVarUrlObj),
|
|
@@ -34504,11 +34623,12 @@ export const RMAApiFp = function(configuration?: Configuration) {
|
|
|
34504
34623
|
/**
|
|
34505
34624
|
* Approve an RMA
|
|
34506
34625
|
* @param {number} id
|
|
34626
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
34507
34627
|
* @param {*} [options] Override http request option.
|
|
34508
34628
|
* @throws {RequiredError}
|
|
34509
34629
|
*/
|
|
34510
|
-
async patchApproveRma(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
34511
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.patchApproveRma(id, options);
|
|
34630
|
+
async patchApproveRma(id: number, patchApproveRmaRequest?: PatchApproveRmaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
34631
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchApproveRma(id, patchApproveRmaRequest, options);
|
|
34512
34632
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
34513
34633
|
const localVarOperationServerBasePath = operationServerMap['RMAApi.patchApproveRma']?.[localVarOperationServerIndex]?.url;
|
|
34514
34634
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -34869,11 +34989,12 @@ export const RMAApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
34869
34989
|
/**
|
|
34870
34990
|
* Approve an RMA
|
|
34871
34991
|
* @param {number} id
|
|
34992
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
34872
34993
|
* @param {*} [options] Override http request option.
|
|
34873
34994
|
* @throws {RequiredError}
|
|
34874
34995
|
*/
|
|
34875
|
-
patchApproveRma(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
34876
|
-
return localVarFp.patchApproveRma(id, options).then((request) => request(axios, basePath));
|
|
34996
|
+
patchApproveRma(id: number, patchApproveRmaRequest?: PatchApproveRmaRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
34997
|
+
return localVarFp.patchApproveRma(id, patchApproveRmaRequest, options).then((request) => request(axios, basePath));
|
|
34877
34998
|
},
|
|
34878
34999
|
/**
|
|
34879
35000
|
* Mark RMA item as binned
|
|
@@ -35182,11 +35303,12 @@ export class RMAApi extends BaseAPI {
|
|
|
35182
35303
|
/**
|
|
35183
35304
|
* Approve an RMA
|
|
35184
35305
|
* @param {number} id
|
|
35306
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
35185
35307
|
* @param {*} [options] Override http request option.
|
|
35186
35308
|
* @throws {RequiredError}
|
|
35187
35309
|
*/
|
|
35188
|
-
public patchApproveRma(id: number, options?: RawAxiosRequestConfig) {
|
|
35189
|
-
return RMAApiFp(this.configuration).patchApproveRma(id, options).then((request) => request(this.axios, this.basePath));
|
|
35310
|
+
public patchApproveRma(id: number, patchApproveRmaRequest?: PatchApproveRmaRequest, options?: RawAxiosRequestConfig) {
|
|
35311
|
+
return RMAApiFp(this.configuration).patchApproveRma(id, patchApproveRmaRequest, options).then((request) => request(this.axios, this.basePath));
|
|
35190
35312
|
}
|
|
35191
35313
|
|
|
35192
35314
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -1694,6 +1694,43 @@ export interface CallBarringModel {
|
|
|
1694
1694
|
*/
|
|
1695
1695
|
'block087Calls': boolean;
|
|
1696
1696
|
}
|
|
1697
|
+
/**
|
|
1698
|
+
* Call Journal Request Model
|
|
1699
|
+
*/
|
|
1700
|
+
export interface CallJournalRequestModel {
|
|
1701
|
+
/**
|
|
1702
|
+
* User Email
|
|
1703
|
+
*/
|
|
1704
|
+
'userEmail': string;
|
|
1705
|
+
/**
|
|
1706
|
+
* Call Note
|
|
1707
|
+
*/
|
|
1708
|
+
'note': string;
|
|
1709
|
+
/**
|
|
1710
|
+
* Call Timestamp
|
|
1711
|
+
*/
|
|
1712
|
+
'timestamp': string;
|
|
1713
|
+
/**
|
|
1714
|
+
* Call Duration
|
|
1715
|
+
*/
|
|
1716
|
+
'duration': string;
|
|
1717
|
+
/**
|
|
1718
|
+
* Call Recording URL
|
|
1719
|
+
*/
|
|
1720
|
+
'recordingUrl': string;
|
|
1721
|
+
/**
|
|
1722
|
+
* Call Transcription
|
|
1723
|
+
*/
|
|
1724
|
+
'transcription': string;
|
|
1725
|
+
/**
|
|
1726
|
+
* Call Summary
|
|
1727
|
+
*/
|
|
1728
|
+
'summary': string;
|
|
1729
|
+
/**
|
|
1730
|
+
* Call Sentiment
|
|
1731
|
+
*/
|
|
1732
|
+
'sentiment': number;
|
|
1733
|
+
}
|
|
1697
1734
|
export interface CallTariff {
|
|
1698
1735
|
'createdDate'?: string;
|
|
1699
1736
|
'id'?: number;
|
|
@@ -2345,6 +2382,22 @@ export interface CrmActivityDTO {
|
|
|
2345
2382
|
* Activity Order ID
|
|
2346
2383
|
*/
|
|
2347
2384
|
'orderId'?: number | null;
|
|
2385
|
+
/**
|
|
2386
|
+
* Call Recording URL
|
|
2387
|
+
*/
|
|
2388
|
+
'recordingUrl'?: string | null;
|
|
2389
|
+
/**
|
|
2390
|
+
* Call Transcription
|
|
2391
|
+
*/
|
|
2392
|
+
'transcription'?: string | null;
|
|
2393
|
+
/**
|
|
2394
|
+
* Call Summary
|
|
2395
|
+
*/
|
|
2396
|
+
'summary'?: string | null;
|
|
2397
|
+
/**
|
|
2398
|
+
* Call Sentiment
|
|
2399
|
+
*/
|
|
2400
|
+
'sentiment'?: number | null;
|
|
2348
2401
|
}
|
|
2349
2402
|
/**
|
|
2350
2403
|
* CRM Contact
|
|
@@ -5420,6 +5473,12 @@ export interface PasswordSenderEntity {
|
|
|
5420
5473
|
*/
|
|
5421
5474
|
'description': string;
|
|
5422
5475
|
}
|
|
5476
|
+
export interface PatchApproveRmaRequest {
|
|
5477
|
+
/**
|
|
5478
|
+
* Send email to customer
|
|
5479
|
+
*/
|
|
5480
|
+
'sendEmail'?: boolean;
|
|
5481
|
+
}
|
|
5423
5482
|
export interface PatchUpdateAccountCnameRequest {
|
|
5424
5483
|
/**
|
|
5425
5484
|
* CNAME
|
|
@@ -14975,6 +15034,12 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
14975
15034
|
* @throws {RequiredError}
|
|
14976
15035
|
*/
|
|
14977
15036
|
postCreateCrmNote: (id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
15037
|
+
/**
|
|
15038
|
+
* Search for contacts by phone number
|
|
15039
|
+
* @param {*} [options] Override http request option.
|
|
15040
|
+
* @throws {RequiredError}
|
|
15041
|
+
*/
|
|
15042
|
+
postSearchByPhone: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
14978
15043
|
};
|
|
14979
15044
|
/**
|
|
14980
15045
|
* CRMApi - functional programming interface
|
|
@@ -15003,6 +15068,12 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
|
15003
15068
|
* @throws {RequiredError}
|
|
15004
15069
|
*/
|
|
15005
15070
|
postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDTO>>;
|
|
15071
|
+
/**
|
|
15072
|
+
* Search for contacts by phone number
|
|
15073
|
+
* @param {*} [options] Override http request option.
|
|
15074
|
+
* @throws {RequiredError}
|
|
15075
|
+
*/
|
|
15076
|
+
postSearchByPhone(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmContactDTO>>;
|
|
15006
15077
|
};
|
|
15007
15078
|
/**
|
|
15008
15079
|
* CRMApi - factory interface
|
|
@@ -15031,6 +15102,12 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
15031
15102
|
* @throws {RequiredError}
|
|
15032
15103
|
*/
|
|
15033
15104
|
postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO>;
|
|
15105
|
+
/**
|
|
15106
|
+
* Search for contacts by phone number
|
|
15107
|
+
* @param {*} [options] Override http request option.
|
|
15108
|
+
* @throws {RequiredError}
|
|
15109
|
+
*/
|
|
15110
|
+
postSearchByPhone(options?: RawAxiosRequestConfig): AxiosPromise<CrmContactDTO>;
|
|
15034
15111
|
};
|
|
15035
15112
|
/**
|
|
15036
15113
|
* CRMApi - object-oriented interface
|
|
@@ -15059,6 +15136,12 @@ export declare class CRMApi extends BaseAPI {
|
|
|
15059
15136
|
* @throws {RequiredError}
|
|
15060
15137
|
*/
|
|
15061
15138
|
postCreateCrmNote(id: number, createCrmNoteBody?: CreateCrmNoteBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDTO, any, {}>>;
|
|
15139
|
+
/**
|
|
15140
|
+
* Search for contacts by phone number
|
|
15141
|
+
* @param {*} [options] Override http request option.
|
|
15142
|
+
* @throws {RequiredError}
|
|
15143
|
+
*/
|
|
15144
|
+
postSearchByPhone(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmContactDTO, any, {}>>;
|
|
15062
15145
|
}
|
|
15063
15146
|
export declare const GetGetCrmActivitiesTypeEnum: {
|
|
15064
15147
|
readonly Alert: "alert";
|
|
@@ -21460,10 +21543,11 @@ export declare const RMAApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
21460
21543
|
/**
|
|
21461
21544
|
* Approve an RMA
|
|
21462
21545
|
* @param {number} id
|
|
21546
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
21463
21547
|
* @param {*} [options] Override http request option.
|
|
21464
21548
|
* @throws {RequiredError}
|
|
21465
21549
|
*/
|
|
21466
|
-
patchApproveRma: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21550
|
+
patchApproveRma: (id: number, patchApproveRmaRequest?: PatchApproveRmaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
21467
21551
|
/**
|
|
21468
21552
|
* Mark RMA item as binned
|
|
21469
21553
|
* @param {number} id
|
|
@@ -21701,10 +21785,11 @@ export declare const RMAApiFp: (configuration?: Configuration) => {
|
|
|
21701
21785
|
/**
|
|
21702
21786
|
* Approve an RMA
|
|
21703
21787
|
* @param {number} id
|
|
21788
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
21704
21789
|
* @param {*} [options] Override http request option.
|
|
21705
21790
|
* @throws {RequiredError}
|
|
21706
21791
|
*/
|
|
21707
|
-
patchApproveRma(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
21792
|
+
patchApproveRma(id: number, patchApproveRmaRequest?: PatchApproveRmaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
21708
21793
|
/**
|
|
21709
21794
|
* Mark RMA item as binned
|
|
21710
21795
|
* @param {number} id
|
|
@@ -21942,10 +22027,11 @@ export declare const RMAApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
21942
22027
|
/**
|
|
21943
22028
|
* Approve an RMA
|
|
21944
22029
|
* @param {number} id
|
|
22030
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
21945
22031
|
* @param {*} [options] Override http request option.
|
|
21946
22032
|
* @throws {RequiredError}
|
|
21947
22033
|
*/
|
|
21948
|
-
patchApproveRma(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
22034
|
+
patchApproveRma(id: number, patchApproveRmaRequest?: PatchApproveRmaRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
21949
22035
|
/**
|
|
21950
22036
|
* Mark RMA item as binned
|
|
21951
22037
|
* @param {number} id
|
|
@@ -22183,10 +22269,11 @@ export declare class RMAApi extends BaseAPI {
|
|
|
22183
22269
|
/**
|
|
22184
22270
|
* Approve an RMA
|
|
22185
22271
|
* @param {number} id
|
|
22272
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
22186
22273
|
* @param {*} [options] Override http request option.
|
|
22187
22274
|
* @throws {RequiredError}
|
|
22188
22275
|
*/
|
|
22189
|
-
patchApproveRma(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
22276
|
+
patchApproveRma(id: number, patchApproveRmaRequest?: PatchApproveRmaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
22190
22277
|
/**
|
|
22191
22278
|
* Mark RMA item as binned
|
|
22192
22279
|
* @param {number} id
|
package/dist/api.js
CHANGED
|
@@ -11148,6 +11148,39 @@ var CRMApiAxiosParamCreator = function (configuration) {
|
|
|
11148
11148
|
});
|
|
11149
11149
|
});
|
|
11150
11150
|
},
|
|
11151
|
+
/**
|
|
11152
|
+
* Search for contacts by phone number
|
|
11153
|
+
* @param {*} [options] Override http request option.
|
|
11154
|
+
* @throws {RequiredError}
|
|
11155
|
+
*/
|
|
11156
|
+
postSearchByPhone: function () {
|
|
11157
|
+
var args_1 = [];
|
|
11158
|
+
for (var _i = 0; _i < arguments.length; _i++) {
|
|
11159
|
+
args_1[_i] = arguments[_i];
|
|
11160
|
+
}
|
|
11161
|
+
return __awaiter(_this, __spreadArray([], args_1, true), void 0, function (options) {
|
|
11162
|
+
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
11163
|
+
if (options === void 0) { options = {}; }
|
|
11164
|
+
return __generator(this, function (_a) {
|
|
11165
|
+
localVarPath = "/crm/contact/search";
|
|
11166
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
11167
|
+
if (configuration) {
|
|
11168
|
+
baseOptions = configuration.baseOptions;
|
|
11169
|
+
}
|
|
11170
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
11171
|
+
localVarHeaderParameter = {};
|
|
11172
|
+
localVarQueryParameter = {};
|
|
11173
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
11174
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
11175
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
11176
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
11177
|
+
return [2 /*return*/, {
|
|
11178
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
11179
|
+
options: localVarRequestOptions,
|
|
11180
|
+
}];
|
|
11181
|
+
});
|
|
11182
|
+
});
|
|
11183
|
+
},
|
|
11151
11184
|
};
|
|
11152
11185
|
};
|
|
11153
11186
|
exports.CRMApiAxiosParamCreator = CRMApiAxiosParamCreator;
|
|
@@ -11225,6 +11258,27 @@ var CRMApiFp = function (configuration) {
|
|
|
11225
11258
|
});
|
|
11226
11259
|
});
|
|
11227
11260
|
},
|
|
11261
|
+
/**
|
|
11262
|
+
* Search for contacts by phone number
|
|
11263
|
+
* @param {*} [options] Override http request option.
|
|
11264
|
+
* @throws {RequiredError}
|
|
11265
|
+
*/
|
|
11266
|
+
postSearchByPhone: function (options) {
|
|
11267
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
11268
|
+
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
11269
|
+
var _a, _b, _c;
|
|
11270
|
+
return __generator(this, function (_d) {
|
|
11271
|
+
switch (_d.label) {
|
|
11272
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postSearchByPhone(options)];
|
|
11273
|
+
case 1:
|
|
11274
|
+
localVarAxiosArgs = _d.sent();
|
|
11275
|
+
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
11276
|
+
localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CRMApi.postSearchByPhone']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
11277
|
+
return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
|
|
11278
|
+
}
|
|
11279
|
+
});
|
|
11280
|
+
});
|
|
11281
|
+
},
|
|
11228
11282
|
};
|
|
11229
11283
|
};
|
|
11230
11284
|
exports.CRMApiFp = CRMApiFp;
|
|
@@ -11263,6 +11317,14 @@ var CRMApiFactory = function (configuration, basePath, axios) {
|
|
|
11263
11317
|
postCreateCrmNote: function (id, createCrmNoteBody, options) {
|
|
11264
11318
|
return localVarFp.postCreateCrmNote(id, createCrmNoteBody, options).then(function (request) { return request(axios, basePath); });
|
|
11265
11319
|
},
|
|
11320
|
+
/**
|
|
11321
|
+
* Search for contacts by phone number
|
|
11322
|
+
* @param {*} [options] Override http request option.
|
|
11323
|
+
* @throws {RequiredError}
|
|
11324
|
+
*/
|
|
11325
|
+
postSearchByPhone: function (options) {
|
|
11326
|
+
return localVarFp.postSearchByPhone(options).then(function (request) { return request(axios, basePath); });
|
|
11327
|
+
},
|
|
11266
11328
|
};
|
|
11267
11329
|
};
|
|
11268
11330
|
exports.CRMApiFactory = CRMApiFactory;
|
|
@@ -11306,6 +11368,15 @@ var CRMApi = /** @class */ (function (_super) {
|
|
|
11306
11368
|
var _this = this;
|
|
11307
11369
|
return (0, exports.CRMApiFp)(this.configuration).postCreateCrmNote(id, createCrmNoteBody, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11308
11370
|
};
|
|
11371
|
+
/**
|
|
11372
|
+
* Search for contacts by phone number
|
|
11373
|
+
* @param {*} [options] Override http request option.
|
|
11374
|
+
* @throws {RequiredError}
|
|
11375
|
+
*/
|
|
11376
|
+
CRMApi.prototype.postSearchByPhone = function (options) {
|
|
11377
|
+
var _this = this;
|
|
11378
|
+
return (0, exports.CRMApiFp)(this.configuration).postSearchByPhone(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
11379
|
+
};
|
|
11309
11380
|
return CRMApi;
|
|
11310
11381
|
}(base_1.BaseAPI));
|
|
11311
11382
|
exports.CRMApi = CRMApi;
|
|
@@ -27066,15 +27137,16 @@ var RMAApiAxiosParamCreator = function (configuration) {
|
|
|
27066
27137
|
/**
|
|
27067
27138
|
* Approve an RMA
|
|
27068
27139
|
* @param {number} id
|
|
27140
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
27069
27141
|
* @param {*} [options] Override http request option.
|
|
27070
27142
|
* @throws {RequiredError}
|
|
27071
27143
|
*/
|
|
27072
|
-
patchApproveRma: function (id_1) {
|
|
27144
|
+
patchApproveRma: function (id_1, patchApproveRmaRequest_1) {
|
|
27073
27145
|
var args_1 = [];
|
|
27074
|
-
for (var _i =
|
|
27075
|
-
args_1[_i -
|
|
27146
|
+
for (var _i = 2; _i < arguments.length; _i++) {
|
|
27147
|
+
args_1[_i - 2] = arguments[_i];
|
|
27076
27148
|
}
|
|
27077
|
-
return __awaiter(_this, __spreadArray([id_1], args_1, true), void 0, function (id, options) {
|
|
27149
|
+
return __awaiter(_this, __spreadArray([id_1, patchApproveRmaRequest_1], args_1, true), void 0, function (id, patchApproveRmaRequest, options) {
|
|
27078
27150
|
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
27079
27151
|
if (options === void 0) { options = {}; }
|
|
27080
27152
|
return __generator(this, function (_a) {
|
|
@@ -27089,9 +27161,11 @@ var RMAApiAxiosParamCreator = function (configuration) {
|
|
|
27089
27161
|
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
27090
27162
|
localVarHeaderParameter = {};
|
|
27091
27163
|
localVarQueryParameter = {};
|
|
27164
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
27092
27165
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
27093
27166
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
27094
27167
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
27168
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(patchApproveRmaRequest, localVarRequestOptions, configuration);
|
|
27095
27169
|
return [2 /*return*/, {
|
|
27096
27170
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
27097
27171
|
options: localVarRequestOptions,
|
|
@@ -28092,16 +28166,17 @@ var RMAApiFp = function (configuration) {
|
|
|
28092
28166
|
/**
|
|
28093
28167
|
* Approve an RMA
|
|
28094
28168
|
* @param {number} id
|
|
28169
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
28095
28170
|
* @param {*} [options] Override http request option.
|
|
28096
28171
|
* @throws {RequiredError}
|
|
28097
28172
|
*/
|
|
28098
|
-
patchApproveRma: function (id, options) {
|
|
28173
|
+
patchApproveRma: function (id, patchApproveRmaRequest, options) {
|
|
28099
28174
|
return __awaiter(this, void 0, void 0, function () {
|
|
28100
28175
|
var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
|
|
28101
28176
|
var _a, _b, _c;
|
|
28102
28177
|
return __generator(this, function (_d) {
|
|
28103
28178
|
switch (_d.label) {
|
|
28104
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchApproveRma(id, options)];
|
|
28179
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchApproveRma(id, patchApproveRmaRequest, options)];
|
|
28105
28180
|
case 1:
|
|
28106
28181
|
localVarAxiosArgs = _d.sent();
|
|
28107
28182
|
localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
@@ -28657,11 +28732,12 @@ var RMAApiFactory = function (configuration, basePath, axios) {
|
|
|
28657
28732
|
/**
|
|
28658
28733
|
* Approve an RMA
|
|
28659
28734
|
* @param {number} id
|
|
28735
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
28660
28736
|
* @param {*} [options] Override http request option.
|
|
28661
28737
|
* @throws {RequiredError}
|
|
28662
28738
|
*/
|
|
28663
|
-
patchApproveRma: function (id, options) {
|
|
28664
|
-
return localVarFp.patchApproveRma(id, options).then(function (request) { return request(axios, basePath); });
|
|
28739
|
+
patchApproveRma: function (id, patchApproveRmaRequest, options) {
|
|
28740
|
+
return localVarFp.patchApproveRma(id, patchApproveRmaRequest, options).then(function (request) { return request(axios, basePath); });
|
|
28665
28741
|
},
|
|
28666
28742
|
/**
|
|
28667
28743
|
* Mark RMA item as binned
|
|
@@ -28974,12 +29050,13 @@ var RMAApi = /** @class */ (function (_super) {
|
|
|
28974
29050
|
/**
|
|
28975
29051
|
* Approve an RMA
|
|
28976
29052
|
* @param {number} id
|
|
29053
|
+
* @param {PatchApproveRmaRequest} [patchApproveRmaRequest]
|
|
28977
29054
|
* @param {*} [options] Override http request option.
|
|
28978
29055
|
* @throws {RequiredError}
|
|
28979
29056
|
*/
|
|
28980
|
-
RMAApi.prototype.patchApproveRma = function (id, options) {
|
|
29057
|
+
RMAApi.prototype.patchApproveRma = function (id, patchApproveRmaRequest, options) {
|
|
28981
29058
|
var _this = this;
|
|
28982
|
-
return (0, exports.RMAApiFp)(this.configuration).patchApproveRma(id, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
29059
|
+
return (0, exports.RMAApiFp)(this.configuration).patchApproveRma(id, patchApproveRmaRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
28983
29060
|
};
|
|
28984
29061
|
/**
|
|
28985
29062
|
* Mark RMA item as binned
|
package/docs/CRMApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://bitbucket.org*
|
|
|
7
7
|
|[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
|
|
8
8
|
|[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
|
|
9
9
|
|[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
|
|
10
|
+
|[**postSearchByPhone**](#postsearchbyphone) | **POST** /crm/contact/search | |
|
|
10
11
|
|
|
11
12
|
# **getGetCrmActivities**
|
|
12
13
|
> CrmActivitiesResponseDTO getGetCrmActivities()
|
|
@@ -173,3 +174,50 @@ No authorization required
|
|
|
173
174
|
|
|
174
175
|
[[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)
|
|
175
176
|
|
|
177
|
+
# **postSearchByPhone**
|
|
178
|
+
> CrmContactDTO postSearchByPhone()
|
|
179
|
+
|
|
180
|
+
Search for contacts by phone number
|
|
181
|
+
|
|
182
|
+
### Example
|
|
183
|
+
|
|
184
|
+
```typescript
|
|
185
|
+
import {
|
|
186
|
+
CRMApi,
|
|
187
|
+
Configuration
|
|
188
|
+
} from 'yellowgrid-api-ts';
|
|
189
|
+
|
|
190
|
+
const configuration = new Configuration();
|
|
191
|
+
const apiInstance = new CRMApi(configuration);
|
|
192
|
+
|
|
193
|
+
const { status, data } = await apiInstance.postSearchByPhone();
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
This endpoint does not have any parameters.
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
### Return type
|
|
201
|
+
|
|
202
|
+
**CrmContactDTO**
|
|
203
|
+
|
|
204
|
+
### Authorization
|
|
205
|
+
|
|
206
|
+
No authorization required
|
|
207
|
+
|
|
208
|
+
### HTTP request headers
|
|
209
|
+
|
|
210
|
+
- **Content-Type**: Not defined
|
|
211
|
+
- **Accept**: application/json
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
### HTTP response details
|
|
215
|
+
| Status code | Description | Response headers |
|
|
216
|
+
|-------------|-------------|------------------|
|
|
217
|
+
|**200** | CRM Contact | - |
|
|
218
|
+
|**400** | Bad Request | - |
|
|
219
|
+
|**401** | Unauthorised | - |
|
|
220
|
+
|**403** | Access Denied | - |
|
|
221
|
+
|
|
222
|
+
[[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)
|
|
223
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# CallJournalRequestModel
|
|
2
|
+
|
|
3
|
+
Call Journal Request Model
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**userEmail** | **string** | User Email | [default to undefined]
|
|
10
|
+
**note** | **string** | Call Note | [default to undefined]
|
|
11
|
+
**timestamp** | **string** | Call Timestamp | [default to undefined]
|
|
12
|
+
**duration** | **string** | Call Duration | [default to undefined]
|
|
13
|
+
**recordingUrl** | **string** | Call Recording URL | [default to undefined]
|
|
14
|
+
**transcription** | **string** | Call Transcription | [default to undefined]
|
|
15
|
+
**summary** | **string** | Call Summary | [default to undefined]
|
|
16
|
+
**sentiment** | **number** | Call Sentiment | [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { CallJournalRequestModel } from 'yellowgrid-api-ts';
|
|
22
|
+
|
|
23
|
+
const instance: CallJournalRequestModel = {
|
|
24
|
+
userEmail,
|
|
25
|
+
note,
|
|
26
|
+
timestamp,
|
|
27
|
+
duration,
|
|
28
|
+
recordingUrl,
|
|
29
|
+
transcription,
|
|
30
|
+
summary,
|
|
31
|
+
sentiment,
|
|
32
|
+
};
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[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/CrmActivityDTO.md
CHANGED
|
@@ -13,6 +13,10 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**user** | **string** | Activity User Name | [optional] [default to undefined]
|
|
14
14
|
**contact** | **string** | Activity Contact Name | [optional] [default to undefined]
|
|
15
15
|
**orderId** | **number** | Activity Order ID | [optional] [default to undefined]
|
|
16
|
+
**recordingUrl** | **string** | Call Recording URL | [optional] [default to undefined]
|
|
17
|
+
**transcription** | **string** | Call Transcription | [optional] [default to undefined]
|
|
18
|
+
**summary** | **string** | Call Summary | [optional] [default to undefined]
|
|
19
|
+
**sentiment** | **number** | Call Sentiment | [optional] [default to undefined]
|
|
16
20
|
|
|
17
21
|
## Example
|
|
18
22
|
|
|
@@ -27,6 +31,10 @@ const instance: CrmActivityDTO = {
|
|
|
27
31
|
user,
|
|
28
32
|
contact,
|
|
29
33
|
orderId,
|
|
34
|
+
recordingUrl,
|
|
35
|
+
transcription,
|
|
36
|
+
summary,
|
|
37
|
+
sentiment,
|
|
30
38
|
};
|
|
31
39
|
```
|
|
32
40
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PatchApproveRmaRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**sendEmail** | **boolean** | Send email to customer | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PatchApproveRmaRequest } from 'yellowgrid-api-ts';
|
|
14
|
+
|
|
15
|
+
const instance: PatchApproveRmaRequest = {
|
|
16
|
+
sendEmail,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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/RMAApi.md
CHANGED
|
@@ -603,16 +603,19 @@ Approve an RMA
|
|
|
603
603
|
```typescript
|
|
604
604
|
import {
|
|
605
605
|
RMAApi,
|
|
606
|
-
Configuration
|
|
606
|
+
Configuration,
|
|
607
|
+
PatchApproveRmaRequest
|
|
607
608
|
} from 'yellowgrid-api-ts';
|
|
608
609
|
|
|
609
610
|
const configuration = new Configuration();
|
|
610
611
|
const apiInstance = new RMAApi(configuration);
|
|
611
612
|
|
|
612
613
|
let id: number; // (default to undefined)
|
|
614
|
+
let patchApproveRmaRequest: PatchApproveRmaRequest; // (optional)
|
|
613
615
|
|
|
614
616
|
const { status, data } = await apiInstance.patchApproveRma(
|
|
615
|
-
id
|
|
617
|
+
id,
|
|
618
|
+
patchApproveRmaRequest
|
|
616
619
|
);
|
|
617
620
|
```
|
|
618
621
|
|
|
@@ -620,6 +623,7 @@ const { status, data } = await apiInstance.patchApproveRma(
|
|
|
620
623
|
|
|
621
624
|
|Name | Type | Description | Notes|
|
|
622
625
|
|------------- | ------------- | ------------- | -------------|
|
|
626
|
+
| **patchApproveRmaRequest** | **PatchApproveRmaRequest**| | |
|
|
623
627
|
| **id** | [**number**] | | defaults to undefined|
|
|
624
628
|
|
|
625
629
|
|
|
@@ -633,7 +637,7 @@ No authorization required
|
|
|
633
637
|
|
|
634
638
|
### HTTP request headers
|
|
635
639
|
|
|
636
|
-
- **Content-Type**:
|
|
640
|
+
- **Content-Type**: application/json
|
|
637
641
|
- **Accept**: Not defined
|
|
638
642
|
|
|
639
643
|
|