yellowgrid-api-ts 3.2.126-dev.0 → 3.2.128-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 +2 -2
- package/README.md +2 -2
- package/api.ts +8 -8
- package/dist/api.d.ts +10 -10
- package/docs/CRMApi.md +4 -4
- package/docs/CrmActivitiesResponseDto.md +3 -3
- package/docs/CrmActivityDto.md +5 -5
- package/docs/CrmDateActivitiesDTO.md +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -53,8 +53,8 @@ docs/CreditNoteItemDTO.md
|
|
|
53
53
|
docs/CreditNoteItemEntity.md
|
|
54
54
|
docs/CreditNoteItemModel.md
|
|
55
55
|
docs/CreditNoteModel.md
|
|
56
|
-
docs/
|
|
57
|
-
docs/
|
|
56
|
+
docs/CrmActivitiesResponseDTO.md
|
|
57
|
+
docs/CrmActivityDTO.md
|
|
58
58
|
docs/CrmContactDTO.md
|
|
59
59
|
docs/CrmDateActivitiesDTO.md
|
|
60
60
|
docs/CrmNoteEntity.md
|
package/README.md
CHANGED
|
@@ -331,8 +331,8 @@ Class | Method | HTTP request | Description
|
|
|
331
331
|
- [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
|
|
332
332
|
- [CreditNoteItemModel](docs/CreditNoteItemModel.md)
|
|
333
333
|
- [CreditNoteModel](docs/CreditNoteModel.md)
|
|
334
|
-
- [
|
|
335
|
-
- [
|
|
334
|
+
- [CrmActivitiesResponseDTO](docs/CrmActivitiesResponseDTO.md)
|
|
335
|
+
- [CrmActivityDTO](docs/CrmActivityDTO.md)
|
|
336
336
|
- [CrmContactDTO](docs/CrmContactDTO.md)
|
|
337
337
|
- [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
|
|
338
338
|
- [CrmNoteEntity](docs/CrmNoteEntity.md)
|
package/api.ts
CHANGED
|
@@ -1605,7 +1605,7 @@ export interface CreditNoteModel {
|
|
|
1605
1605
|
/**
|
|
1606
1606
|
* CRM Activities Response
|
|
1607
1607
|
*/
|
|
1608
|
-
export interface
|
|
1608
|
+
export interface CrmActivitiesResponseDTO {
|
|
1609
1609
|
/**
|
|
1610
1610
|
* Dates
|
|
1611
1611
|
*/
|
|
@@ -1618,7 +1618,7 @@ export interface CrmActivitiesResponseDto {
|
|
|
1618
1618
|
/**
|
|
1619
1619
|
* CRM Activity
|
|
1620
1620
|
*/
|
|
1621
|
-
export interface
|
|
1621
|
+
export interface CrmActivityDTO {
|
|
1622
1622
|
/**
|
|
1623
1623
|
* Activity Type
|
|
1624
1624
|
*/
|
|
@@ -1626,7 +1626,7 @@ export interface CrmActivityDto {
|
|
|
1626
1626
|
/**
|
|
1627
1627
|
* Date Time
|
|
1628
1628
|
*/
|
|
1629
|
-
'
|
|
1629
|
+
'timestamp'?: string | null;
|
|
1630
1630
|
/**
|
|
1631
1631
|
* Activity Title
|
|
1632
1632
|
*/
|
|
@@ -1692,7 +1692,7 @@ export interface CrmDateActivitiesDTO {
|
|
|
1692
1692
|
/**
|
|
1693
1693
|
* Activities
|
|
1694
1694
|
*/
|
|
1695
|
-
'activities'?: Array<
|
|
1695
|
+
'activities'?: Array<CrmActivityDTO>;
|
|
1696
1696
|
}
|
|
1697
1697
|
/**
|
|
1698
1698
|
* CrmNotesEntity
|
|
@@ -10276,7 +10276,7 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
10276
10276
|
* @param {*} [options] Override http request option.
|
|
10277
10277
|
* @throws {RequiredError}
|
|
10278
10278
|
*/
|
|
10279
|
-
async getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10279
|
+
async getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivitiesResponseDTO>> {
|
|
10280
10280
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getGetCrmActivities(id, type, userId, options);
|
|
10281
10281
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10282
10282
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.getGetCrmActivities']?.[localVarOperationServerIndex]?.url;
|
|
@@ -10300,7 +10300,7 @@ export const CRMApiFp = function(configuration?: Configuration) {
|
|
|
10300
10300
|
* @param {*} [options] Override http request option.
|
|
10301
10301
|
* @throws {RequiredError}
|
|
10302
10302
|
*/
|
|
10303
|
-
async postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
10303
|
+
async postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDTO>> {
|
|
10304
10304
|
const localVarAxiosArgs = await localVarAxiosParamCreator.postCreateCrmNote(id, postCreateCrmNoteRequest, options);
|
|
10305
10305
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
10306
10306
|
const localVarOperationServerBasePath = operationServerMap['CRMApi.postCreateCrmNote']?.[localVarOperationServerIndex]?.url;
|
|
@@ -10323,7 +10323,7 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10323
10323
|
* @param {*} [options] Override http request option.
|
|
10324
10324
|
* @throws {RequiredError}
|
|
10325
10325
|
*/
|
|
10326
|
-
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10326
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivitiesResponseDTO> {
|
|
10327
10327
|
return localVarFp.getGetCrmActivities(id, type, userId, options).then((request) => request(axios, basePath));
|
|
10328
10328
|
},
|
|
10329
10329
|
/**
|
|
@@ -10341,7 +10341,7 @@ export const CRMApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
10341
10341
|
* @param {*} [options] Override http request option.
|
|
10342
10342
|
* @throws {RequiredError}
|
|
10343
10343
|
*/
|
|
10344
|
-
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
10344
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO> {
|
|
10345
10345
|
return localVarFp.postCreateCrmNote(id, postCreateCrmNoteRequest, options).then((request) => request(axios, basePath));
|
|
10346
10346
|
},
|
|
10347
10347
|
};
|
package/dist/api.d.ts
CHANGED
|
@@ -1588,7 +1588,7 @@ export interface CreditNoteModel {
|
|
|
1588
1588
|
/**
|
|
1589
1589
|
* CRM Activities Response
|
|
1590
1590
|
*/
|
|
1591
|
-
export interface
|
|
1591
|
+
export interface CrmActivitiesResponseDTO {
|
|
1592
1592
|
/**
|
|
1593
1593
|
* Dates
|
|
1594
1594
|
*/
|
|
@@ -1601,7 +1601,7 @@ export interface CrmActivitiesResponseDto {
|
|
|
1601
1601
|
/**
|
|
1602
1602
|
* CRM Activity
|
|
1603
1603
|
*/
|
|
1604
|
-
export interface
|
|
1604
|
+
export interface CrmActivityDTO {
|
|
1605
1605
|
/**
|
|
1606
1606
|
* Activity Type
|
|
1607
1607
|
*/
|
|
@@ -1609,7 +1609,7 @@ export interface CrmActivityDto {
|
|
|
1609
1609
|
/**
|
|
1610
1610
|
* Date Time
|
|
1611
1611
|
*/
|
|
1612
|
-
'
|
|
1612
|
+
'timestamp'?: string | null;
|
|
1613
1613
|
/**
|
|
1614
1614
|
* Activity Title
|
|
1615
1615
|
*/
|
|
@@ -1675,7 +1675,7 @@ export interface CrmDateActivitiesDTO {
|
|
|
1675
1675
|
/**
|
|
1676
1676
|
* Activities
|
|
1677
1677
|
*/
|
|
1678
|
-
'activities'?: Array<
|
|
1678
|
+
'activities'?: Array<CrmActivityDTO>;
|
|
1679
1679
|
}
|
|
1680
1680
|
/**
|
|
1681
1681
|
* CrmNotesEntity
|
|
@@ -9007,7 +9007,7 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
|
9007
9007
|
* @param {*} [options] Override http request option.
|
|
9008
9008
|
* @throws {RequiredError}
|
|
9009
9009
|
*/
|
|
9010
|
-
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
9010
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivitiesResponseDTO>>;
|
|
9011
9011
|
/**
|
|
9012
9012
|
* Search for contacts by phone number
|
|
9013
9013
|
* @param {*} [options] Override http request option.
|
|
@@ -9021,7 +9021,7 @@ export declare const CRMApiFp: (configuration?: Configuration) => {
|
|
|
9021
9021
|
* @param {*} [options] Override http request option.
|
|
9022
9022
|
* @throws {RequiredError}
|
|
9023
9023
|
*/
|
|
9024
|
-
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
9024
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CrmActivityDTO>>;
|
|
9025
9025
|
};
|
|
9026
9026
|
/**
|
|
9027
9027
|
* CRMApi - factory interface
|
|
@@ -9035,7 +9035,7 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
9035
9035
|
* @param {*} [options] Override http request option.
|
|
9036
9036
|
* @throws {RequiredError}
|
|
9037
9037
|
*/
|
|
9038
|
-
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
9038
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivitiesResponseDTO>;
|
|
9039
9039
|
/**
|
|
9040
9040
|
* Search for contacts by phone number
|
|
9041
9041
|
* @param {*} [options] Override http request option.
|
|
@@ -9049,7 +9049,7 @@ export declare const CRMApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
9049
9049
|
* @param {*} [options] Override http request option.
|
|
9050
9050
|
* @throws {RequiredError}
|
|
9051
9051
|
*/
|
|
9052
|
-
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
9052
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<CrmActivityDTO>;
|
|
9053
9053
|
};
|
|
9054
9054
|
/**
|
|
9055
9055
|
* CRMApi - object-oriented interface
|
|
@@ -9063,7 +9063,7 @@ export declare class CRMApi extends BaseAPI {
|
|
|
9063
9063
|
* @param {*} [options] Override http request option.
|
|
9064
9064
|
* @throws {RequiredError}
|
|
9065
9065
|
*/
|
|
9066
|
-
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
9066
|
+
getGetCrmActivities(id: number, type?: GetGetCrmActivitiesTypeEnum, userId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivitiesResponseDTO, any, {}>>;
|
|
9067
9067
|
/**
|
|
9068
9068
|
* Search for contacts by phone number
|
|
9069
9069
|
* @param {*} [options] Override http request option.
|
|
@@ -9077,7 +9077,7 @@ export declare class CRMApi extends BaseAPI {
|
|
|
9077
9077
|
* @param {*} [options] Override http request option.
|
|
9078
9078
|
* @throws {RequiredError}
|
|
9079
9079
|
*/
|
|
9080
|
-
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
9080
|
+
postCreateCrmNote(id: number, postCreateCrmNoteRequest?: PostCreateCrmNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CrmActivityDTO, any, {}>>;
|
|
9081
9081
|
}
|
|
9082
9082
|
export declare const GetGetCrmActivitiesTypeEnum: {
|
|
9083
9083
|
readonly Alert: "alert";
|
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
|
-
>
|
|
12
|
+
> CrmActivitiesResponseDTO getGetCrmActivities()
|
|
13
13
|
|
|
14
14
|
Get Customer CRM Activities
|
|
15
15
|
|
|
@@ -46,7 +46,7 @@ const { status, data } = await apiInstance.getGetCrmActivities(
|
|
|
46
46
|
|
|
47
47
|
### Return type
|
|
48
48
|
|
|
49
|
-
**
|
|
49
|
+
**CrmActivitiesResponseDTO**
|
|
50
50
|
|
|
51
51
|
### Authorization
|
|
52
52
|
|
|
@@ -116,7 +116,7 @@ No authorization required
|
|
|
116
116
|
[[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)
|
|
117
117
|
|
|
118
118
|
# **postCreateCrmNote**
|
|
119
|
-
>
|
|
119
|
+
> CrmActivityDTO postCreateCrmNote()
|
|
120
120
|
|
|
121
121
|
Create CRM Note
|
|
122
122
|
|
|
@@ -151,7 +151,7 @@ const { status, data } = await apiInstance.postCreateCrmNote(
|
|
|
151
151
|
|
|
152
152
|
### Return type
|
|
153
153
|
|
|
154
|
-
**
|
|
154
|
+
**CrmActivityDTO**
|
|
155
155
|
|
|
156
156
|
### Authorization
|
|
157
157
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CrmActivitiesResponseDTO
|
|
2
2
|
|
|
3
3
|
CRM Activities Response
|
|
4
4
|
|
|
@@ -12,9 +12,9 @@ Name | Type | Description | Notes
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import {
|
|
15
|
+
import { CrmActivitiesResponseDTO } from 'yellowgrid-api-ts';
|
|
16
16
|
|
|
17
|
-
const instance:
|
|
17
|
+
const instance: CrmActivitiesResponseDTO = {
|
|
18
18
|
dates,
|
|
19
19
|
agents,
|
|
20
20
|
};
|
package/docs/CrmActivityDto.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CrmActivityDTO
|
|
2
2
|
|
|
3
3
|
CRM Activity
|
|
4
4
|
|
|
@@ -7,7 +7,7 @@ CRM Activity
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**type** | **string** | Activity Type | [optional] [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**timestamp** | **string** | Date Time | [optional] [default to undefined]
|
|
11
11
|
**title** | **string** | Activity Title | [optional] [default to undefined]
|
|
12
12
|
**description** | **string** | Activity Description | [optional] [default to undefined]
|
|
13
13
|
**url** | **string** | Activity URL | [optional] [default to undefined]
|
|
@@ -17,11 +17,11 @@ Name | Type | Description | Notes
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
19
19
|
```typescript
|
|
20
|
-
import {
|
|
20
|
+
import { CrmActivityDTO } from 'yellowgrid-api-ts';
|
|
21
21
|
|
|
22
|
-
const instance:
|
|
22
|
+
const instance: CrmActivityDTO = {
|
|
23
23
|
type,
|
|
24
|
-
|
|
24
|
+
timestamp,
|
|
25
25
|
title,
|
|
26
26
|
description,
|
|
27
27
|
url,
|
|
@@ -7,7 +7,7 @@ CRM Date Activities
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
9
|
**date** | **string** | Date Time | [optional] [default to undefined]
|
|
10
|
-
**activities** | [**Array<
|
|
10
|
+
**activities** | [**Array<CrmActivityDTO>**](CrmActivityDTO.md) | Activities | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|