yellowgrid-api-ts 3.2.122-dev.0 → 3.2.124-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 +1 -0
- package/README.md +1 -0
- package/api.ts +25 -16
- package/dist/api.d.ts +25 -12
- package/dist/api.js +8 -12
- package/docs/CRMApi.md +6 -6
- package/docs/CrmDateActivitiesDTO.md +23 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
package/README.md
CHANGED
|
@@ -332,6 +332,7 @@ Class | Method | HTTP request | Description
|
|
|
332
332
|
- [CreditNoteModel](docs/CreditNoteModel.md)
|
|
333
333
|
- [CrmActivityDto](docs/CrmActivityDto.md)
|
|
334
334
|
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
335
|
+
- [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
|
|
335
336
|
- [CrmNoteEntity](docs/CrmNoteEntity.md)
|
|
336
337
|
- [CrmNoteModel](docs/CrmNoteModel.md)
|
|
337
338
|
- [CustomerInformationModel](docs/CustomerInformationModel.md)
|
package/api.ts
CHANGED
|
@@ -1664,6 +1664,19 @@ export interface CrmContactDTO {
|
|
|
1664
1664
|
*/
|
|
1665
1665
|
'url'?: string;
|
|
1666
1666
|
}
|
|
1667
|
+
/**
|
|
1668
|
+
* CRM Date Activities
|
|
1669
|
+
*/
|
|
1670
|
+
export interface CrmDateActivitiesDTO {
|
|
1671
|
+
/**
|
|
1672
|
+
* Date Time
|
|
1673
|
+
*/
|
|
1674
|
+
'date'?: string | null;
|
|
1675
|
+
/**
|
|
1676
|
+
* Activities
|
|
1677
|
+
*/
|
|
1678
|
+
'activities'?: Array<CrmActivityDto>;
|
|
1679
|
+
}
|
|
1667
1680
|
/**
|
|
1668
1681
|
* CrmNotesEntity
|
|
1669
1682
|
*/
|
|
@@ -10124,18 +10137,14 @@ export const CRMApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
10124
10137
|
/**
|
|
10125
10138
|
* Get Customer CRM Activities
|
|
10126
10139
|
* @param {number} id Account ID
|
|
10127
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10128
|
-
* @param {number} userId Activity Created By
|
|
10140
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
10141
|
+
* @param {number} [userId] Activity Created By
|
|
10129
10142
|
* @param {*} [options] Override http request option.
|
|
10130
10143
|
* @throws {RequiredError}
|
|
10131
10144
|
*/
|
|
10132
|
-
getGetCrmActivities: async (id: number, type
|
|
10145
|
+
getGetCrmActivities: async (id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
10133
10146
|
// verify required parameter 'id' is not null or undefined
|
|
10134
10147
|
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
10148
|
const localVarPath = `/admin/crm/{id}/activities`
|
|
10140
10149
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
10141
10150
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -10245,12 +10254,12 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
10245
10254
|
/**
|
|
10246
10255
|
* Get Customer CRM Activities
|
|
10247
10256
|
* @param {number} id Account ID
|
|
10248
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10249
|
-
* @param {number} userId Activity Created By
|
|
10257
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
10258
|
+
* @param {number} [userId] Activity Created By
|
|
10250
10259
|
* @param {*} [options] Override http request option.
|
|
10251
10260
|
* @throws {RequiredError}
|
|
10252
10261
|
*/
|
|
10253
|
-
async getGetCrmActivities(id: number, type
|
|
10262
|
+
async getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmDateActivitiesDTO>>> {
|
|
10254
10263
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCrmActivities(id, type, userId, options);
|
|
10255
10264
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10256
10265
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.getGetCrmActivities']?.[localVarOperationServerIndex]?.url;
|
|
@@ -10292,12 +10301,12 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10292
10301
|
/**
|
|
10293
10302
|
* Get Customer CRM Activities
|
|
10294
10303
|
* @param {number} id Account ID
|
|
10295
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10296
|
-
* @param {number} userId Activity Created By
|
|
10304
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
10305
|
+
* @param {number} [userId] Activity Created By
|
|
10297
10306
|
* @param {*} [options] Override http request option.
|
|
10298
10307
|
* @throws {RequiredError}
|
|
10299
10308
|
*/
|
|
10300
|
-
getGetCrmActivities(id: number, type
|
|
10309
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmDateActivitiesDTO>> {
|
|
10301
10310
|
return localVarFp.getGetCrmActivities(id, type, userId, options).then((request) => request(axios, basePath));
|
|
10302
10311
|
},
|
|
10303
10312
|
/**
|
|
@@ -10328,12 +10337,12 @@ export class CRMApi extends BaseAPI {
|
|
|
10328
10337
|
/**
|
|
10329
10338
|
* Get Customer CRM Activities
|
|
10330
10339
|
* @param {number} id Account ID
|
|
10331
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
10332
|
-
* @param {number} userId Activity Created By
|
|
10340
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
10341
|
+
* @param {number} [userId] Activity Created By
|
|
10333
10342
|
* @param {*} [options] Override http request option.
|
|
10334
10343
|
* @throws {RequiredError}
|
|
10335
10344
|
*/
|
|
10336
|
-
public getGetCrmActivities(id: number, type
|
|
10345
|
+
public getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig) {
|
|
10337
10346
|
return CRMApiFp(this.configuration).getGetCrmActivities(id, type, userId, options).then((request) => request(this.axios, this.basePath));
|
|
10338
10347
|
}
|
|
10339
10348
|
|
package/dist/api.d.ts
CHANGED
|
@@ -1647,6 +1647,19 @@ export interface CrmContactDTO {
|
|
|
1647
1647
|
*/
|
|
1648
1648
|
'url'?: string;
|
|
1649
1649
|
}
|
|
1650
|
+
/**
|
|
1651
|
+
* CRM Date Activities
|
|
1652
|
+
*/
|
|
1653
|
+
export interface CrmDateActivitiesDTO {
|
|
1654
|
+
/**
|
|
1655
|
+
* Date Time
|
|
1656
|
+
*/
|
|
1657
|
+
'date'?: string | null;
|
|
1658
|
+
/**
|
|
1659
|
+
* Activities
|
|
1660
|
+
*/
|
|
1661
|
+
'activities'?: Array<CrmActivityDto>;
|
|
1662
|
+
}
|
|
1650
1663
|
/**
|
|
1651
1664
|
* CrmNotesEntity
|
|
1652
1665
|
*/
|
|
@@ -8944,12 +8957,12 @@ export declare const CRMApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
8944
8957
|
/**
|
|
8945
8958
|
* Get Customer CRM Activities
|
|
8946
8959
|
* @param {number} id Account ID
|
|
8947
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
8948
|
-
* @param {number} userId Activity Created By
|
|
8960
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
8961
|
+
* @param {number} [userId] Activity Created By
|
|
8949
8962
|
* @param {*} [options] Override http request option.
|
|
8950
8963
|
* @throws {RequiredError}
|
|
8951
8964
|
*/
|
|
8952
|
-
getGetCrmActivities: (id: number, type
|
|
8965
|
+
getGetCrmActivities: (id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
8953
8966
|
/**
|
|
8954
8967
|
* Search for contacts by phone number
|
|
8955
8968
|
* @param {*} [options] Override http request option.
|
|
@@ -8972,12 +8985,12 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
|
8972
8985
|
/**
|
|
8973
8986
|
* Get Customer CRM Activities
|
|
8974
8987
|
* @param {number} id Account ID
|
|
8975
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
8976
|
-
* @param {number} userId Activity Created By
|
|
8988
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
8989
|
+
* @param {number} [userId] Activity Created By
|
|
8977
8990
|
* @param {*} [options] Override http request option.
|
|
8978
8991
|
* @throws {RequiredError}
|
|
8979
8992
|
*/
|
|
8980
|
-
getGetCrmActivities(id: number, type
|
|
8993
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CrmDateActivitiesDTO>>>;
|
|
8981
8994
|
/**
|
|
8982
8995
|
* Search for contacts by phone number
|
|
8983
8996
|
* @param {*} [options] Override http request option.
|
|
@@ -9000,12 +9013,12 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
9000
9013
|
/**
|
|
9001
9014
|
* Get Customer CRM Activities
|
|
9002
9015
|
* @param {number} id Account ID
|
|
9003
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
9004
|
-
* @param {number} userId Activity Created By
|
|
9016
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
9017
|
+
* @param {number} [userId] Activity Created By
|
|
9005
9018
|
* @param {*} [options] Override http request option.
|
|
9006
9019
|
* @throws {RequiredError}
|
|
9007
9020
|
*/
|
|
9008
|
-
getGetCrmActivities(id: number, type
|
|
9021
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<CrmDateActivitiesDTO>>;
|
|
9009
9022
|
/**
|
|
9010
9023
|
* Search for contacts by phone number
|
|
9011
9024
|
* @param {*} [options] Override http request option.
|
|
@@ -9028,12 +9041,12 @@ export declare class CRMApi extends BaseAPI {
|
|
|
9028
9041
|
/**
|
|
9029
9042
|
* Get Customer CRM Activities
|
|
9030
9043
|
* @param {number} id Account ID
|
|
9031
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
9032
|
-
* @param {number} userId Activity Created By
|
|
9044
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
9045
|
+
* @param {number} [userId] Activity Created By
|
|
9033
9046
|
* @param {*} [options] Override http request option.
|
|
9034
9047
|
* @throws {RequiredError}
|
|
9035
9048
|
*/
|
|
9036
|
-
getGetCrmActivities(id: number, type
|
|
9049
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmDateActivitiesDTO[], any, {}>>;
|
|
9037
9050
|
/**
|
|
9038
9051
|
* Search for contacts by phone number
|
|
9039
9052
|
* @param {*} [options] Override http request option.
|
package/dist/api.js
CHANGED
|
@@ -2861,8 +2861,8 @@ var CRMApiAxiosParamCreator = function (configuration) {
|
|
|
2861
2861
|
/**
|
|
2862
2862
|
* Get Customer CRM Activities
|
|
2863
2863
|
* @param {number} id Account ID
|
|
2864
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
2865
|
-
* @param {number} userId Activity Created By
|
|
2864
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
2865
|
+
* @param {number} [userId] Activity Created By
|
|
2866
2866
|
* @param {*} [options] Override http request option.
|
|
2867
2867
|
* @throws {RequiredError}
|
|
2868
2868
|
*/
|
|
@@ -2877,10 +2877,6 @@ var CRMApiAxiosParamCreator = function (configuration) {
|
|
|
2877
2877
|
return __generator(this, function (_a) {
|
|
2878
2878
|
// verify required parameter 'id' is not null or undefined
|
|
2879
2879
|
(0, common_1.assertParamExists)('getGetCrmActivities', 'id', id);
|
|
2880
|
-
// verify required parameter 'type' is not null or undefined
|
|
2881
|
-
(0, common_1.assertParamExists)('getGetCrmActivities', 'type', type);
|
|
2882
|
-
// verify required parameter 'userId' is not null or undefined
|
|
2883
|
-
(0, common_1.assertParamExists)('getGetCrmActivities', 'userId', userId);
|
|
2884
2880
|
localVarPath = "/admin/crm/{id}/activities"
|
|
2885
2881
|
.replace("{".concat("id", "}"), encodeURIComponent(String(id)));
|
|
2886
2882
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -2992,8 +2988,8 @@ var CRMApiFp = function (configuration) {
|
|
|
2992
2988
|
/**
|
|
2993
2989
|
* Get Customer CRM Activities
|
|
2994
2990
|
* @param {number} id Account ID
|
|
2995
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
2996
|
-
* @param {number} userId Activity Created By
|
|
2991
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
2992
|
+
* @param {number} [userId] Activity Created By
|
|
2997
2993
|
* @param {*} [options] Override http request option.
|
|
2998
2994
|
* @throws {RequiredError}
|
|
2999
2995
|
*/
|
|
@@ -3069,8 +3065,8 @@ var CRMApiFactory = function (configuration, basePath, axios) {
|
|
|
3069
3065
|
/**
|
|
3070
3066
|
* Get Customer CRM Activities
|
|
3071
3067
|
* @param {number} id Account ID
|
|
3072
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
3073
|
-
* @param {number} userId Activity Created By
|
|
3068
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
3069
|
+
* @param {number} [userId] Activity Created By
|
|
3074
3070
|
* @param {*} [options] Override http request option.
|
|
3075
3071
|
* @throws {RequiredError}
|
|
3076
3072
|
*/
|
|
@@ -3109,8 +3105,8 @@ var CRMApi = /** @class */ (function (_super) {
|
|
|
3109
3105
|
/**
|
|
3110
3106
|
* Get Customer CRM Activities
|
|
3111
3107
|
* @param {number} id Account ID
|
|
3112
|
-
* @param {GetGetCrmActivitiesTypeEnum} type Activity Type
|
|
3113
|
-
* @param {number} userId Activity Created By
|
|
3108
|
+
* @param {GetGetCrmActivitiesTypeEnum} [type] Activity Type
|
|
3109
|
+
* @param {number} [userId] Activity Created By
|
|
3114
3110
|
* @param {*} [options] Override http request option.
|
|
3115
3111
|
* @throws {RequiredError}
|
|
3116
3112
|
*/
|
package/docs/CRMApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://localhost*
|
|
|
9
9
|
|[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
|
|
10
10
|
|
|
11
11
|
# **getGetCrmActivities**
|
|
12
|
-
> Array<
|
|
12
|
+
> Array<CrmDateActivitiesDTO> getGetCrmActivities()
|
|
13
13
|
|
|
14
14
|
Get Customer CRM Activities
|
|
15
15
|
|
|
@@ -25,8 +25,8 @@ const configuration = new Configuration();
|
|
|
25
25
|
const apiInstance = new CRMApi(configuration);
|
|
26
26
|
|
|
27
27
|
let id: number; //Account ID (default to undefined)
|
|
28
|
-
let type: 'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (default to undefined)
|
|
29
|
-
let userId: number; //Activity Created By (default to undefined)
|
|
28
|
+
let type: 'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'; //Activity Type (optional) (default to undefined)
|
|
29
|
+
let userId: number; //Activity Created By (optional) (default to undefined)
|
|
30
30
|
|
|
31
31
|
const { status, data } = await apiInstance.getGetCrmActivities(
|
|
32
32
|
id,
|
|
@@ -40,13 +40,13 @@ const { status, data } = await apiInstance.getGetCrmActivities(
|
|
|
40
40
|
|Name | Type | Description | Notes|
|
|
41
41
|
|------------- | ------------- | ------------- | -------------|
|
|
42
42
|
| **id** | [**number**] | Account ID | defaults to undefined|
|
|
43
|
-
| **type** | [**'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'**]**Array<'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'>** | Activity Type | defaults to undefined|
|
|
44
|
-
| **userId** | [**number**] | Activity Created By | defaults to undefined|
|
|
43
|
+
| **type** | [**'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'**]**Array<'alert' | 'call' | 'note' | 'order' | 'quote' | 'tcx_order'>** | Activity Type | (optional) defaults to undefined|
|
|
44
|
+
| **userId** | [**number**] | Activity Created By | (optional) defaults to undefined|
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
### Return type
|
|
48
48
|
|
|
49
|
-
**Array<
|
|
49
|
+
**Array<CrmDateActivitiesDTO>**
|
|
50
50
|
|
|
51
51
|
### Authorization
|
|
52
52
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CrmDateActivitiesDTO
|
|
2
|
+
|
|
3
|
+
CRM Date Activities
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**date** | **string** | Date Time | [optional] [default to undefined]
|
|
10
|
+
**activities** | [**Array<CrmActivityDto>**](CrmActivityDto.md) | Activities | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CrmDateActivitiesDTO } from 'yellowgrid-api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: CrmDateActivitiesDTO = {
|
|
18
|
+
date,
|
|
19
|
+
activities,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|