yellowgrid-api-ts 3.2.120-dev.0 → 3.2.121-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.
Files changed (12) hide show
  1. package/.openapi-generator/FILES +4 -1
  2. package/README.md +6 -1
  3. package/api.ts +298 -20
  4. package/dist/api.d.ts +206 -14
  5. package/dist/api.js +196 -15
  6. package/docs/CRMApi.md +120 -0
  7. package/docs/CrmActivityDto.md +33 -0
  8. package/docs/CrmNoteEntity.md +39 -0
  9. package/docs/CrmNoteModel.md +39 -0
  10. package/docs/NumberPortingApi.md +5 -5
  11. package/docs/PostCreateCrmNoteRequest.md +20 -0
  12. package/package.json +1 -1
package/docs/CRMApi.md CHANGED
@@ -4,7 +4,69 @@ All URIs are relative to *https://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
7
8
  |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
9
+ |[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
10
+
11
+ # **getGetCrmActivities**
12
+ > Array<CrmActivityDto> getGetCrmActivities()
13
+
14
+ Get Customer CRM Activities
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ CRMApi,
21
+ Configuration
22
+ } from 'yellowgrid-api-ts';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new CRMApi(configuration);
26
+
27
+ let id: string; //Xero ID (default to undefined)
28
+ let type: string; //Activity Type (default to undefined)
29
+ let userId: string; //Activity Created By (default to undefined)
30
+
31
+ const { status, data } = await apiInstance.getGetCrmActivities(
32
+ id,
33
+ type,
34
+ userId
35
+ );
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ |Name | Type | Description | Notes|
41
+ |------------- | ------------- | ------------- | -------------|
42
+ | **id** | [**string**] | Xero ID | defaults to undefined|
43
+ | **type** | [**string**] | Activity Type | defaults to undefined|
44
+ | **userId** | [**string**] | Activity Created By | defaults to undefined|
45
+
46
+
47
+ ### Return type
48
+
49
+ **Array<CrmActivityDto>**
50
+
51
+ ### Authorization
52
+
53
+ No authorization required
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: Not defined
58
+ - **Accept**: application/json
59
+
60
+
61
+ ### HTTP response details
62
+ | Status code | Description | Response headers |
63
+ |-------------|-------------|------------------|
64
+ |**200** | CRM Activities | - |
65
+ |**400** | Bad Request | - |
66
+ |**401** | Unauthorised | - |
67
+ |**403** | Access Denied | - |
68
+
69
+ [[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)
8
70
 
9
71
  # **getSearchByPhone**
10
72
  > CrmContactDTO getSearchByPhone()
@@ -53,3 +115,61 @@ No authorization required
53
115
 
54
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)
55
117
 
118
+ # **postCreateCrmNote**
119
+ > CrmActivityDto postCreateCrmNote()
120
+
121
+ Create CRM Note
122
+
123
+ ### Example
124
+
125
+ ```typescript
126
+ import {
127
+ CRMApi,
128
+ Configuration,
129
+ PostCreateCrmNoteRequest
130
+ } from 'yellowgrid-api-ts';
131
+
132
+ const configuration = new Configuration();
133
+ const apiInstance = new CRMApi(configuration);
134
+
135
+ let id: string; //Xero ID (default to undefined)
136
+ let postCreateCrmNoteRequest: PostCreateCrmNoteRequest; //CRM Note Request (optional)
137
+
138
+ const { status, data } = await apiInstance.postCreateCrmNote(
139
+ id,
140
+ postCreateCrmNoteRequest
141
+ );
142
+ ```
143
+
144
+ ### Parameters
145
+
146
+ |Name | Type | Description | Notes|
147
+ |------------- | ------------- | ------------- | -------------|
148
+ | **postCreateCrmNoteRequest** | **PostCreateCrmNoteRequest**| CRM Note Request | |
149
+ | **id** | [**string**] | Xero ID | defaults to undefined|
150
+
151
+
152
+ ### Return type
153
+
154
+ **CrmActivityDto**
155
+
156
+ ### Authorization
157
+
158
+ No authorization required
159
+
160
+ ### HTTP request headers
161
+
162
+ - **Content-Type**: application/json
163
+ - **Accept**: application/json
164
+
165
+
166
+ ### HTTP response details
167
+ | Status code | Description | Response headers |
168
+ |-------------|-------------|------------------|
169
+ |**200** | CRM Activity | - |
170
+ |**400** | Bad Request | - |
171
+ |**401** | Unauthorised | - |
172
+ |**403** | Access Denied | - |
173
+
174
+ [[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
+
package/docs/CrmActivityDto.md ADDED
@@ -0,0 +1,33 @@
1
+ # CrmActivityDto
2
+
3
+ CRM Activity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **type** | **string** | Activity Type | [optional] [default to undefined]
10
+ **timeStamp** | **string** | Date Time | [optional] [default to undefined]
11
+ **title** | **string** | Activity Title | [optional] [default to undefined]
12
+ **description** | **string** | Activity Description | [optional] [default to undefined]
13
+ **url** | **string** | Activity URL | [optional] [default to undefined]
14
+ **user** | **string** | Activity User Name | [optional] [default to undefined]
15
+ **contact** | **string** | Activity Contact Name | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { CrmActivityDto } from 'yellowgrid-api-ts';
21
+
22
+ const instance: CrmActivityDto = {
23
+ type,
24
+ timeStamp,
25
+ title,
26
+ description,
27
+ url,
28
+ user,
29
+ contact,
30
+ };
31
+ ```
32
+
33
+ [[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/CrmNoteEntity.md ADDED
@@ -0,0 +1,39 @@
1
+ # CrmNoteEntity
2
+
3
+ CrmNotesEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **customerId** | **string** | customerId | [optional] [default to undefined]
11
+ **userId** | **number** | userId | [optional] [default to undefined]
12
+ **type** | **string** | type | [optional] [default to undefined]
13
+ **note** | **string** | note | [optional] [default to undefined]
14
+ **timestamp** | **string** | timestamp | [optional] [default to undefined]
15
+ **journalTime** | **string** | journalTime | [optional] [default to undefined]
16
+ **duration** | **string** | duration | [optional] [default to undefined]
17
+ **callType** | **string** | callType | [optional] [default to undefined]
18
+ **callId** | **number** | callId | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { CrmNoteEntity } from 'yellowgrid-api-ts';
24
+
25
+ const instance: CrmNoteEntity = {
26
+ id,
27
+ customerId,
28
+ userId,
29
+ type,
30
+ note,
31
+ timestamp,
32
+ journalTime,
33
+ duration,
34
+ callType,
35
+ callId,
36
+ };
37
+ ```
38
+
39
+ [[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/CrmNoteModel.md ADDED
@@ -0,0 +1,39 @@
1
+ # CrmNoteModel
2
+
3
+ CrmNotesEntity
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **id** | **number** | id | [optional] [default to undefined]
10
+ **customerId** | **string** | customerId | [optional] [default to undefined]
11
+ **userId** | **number** | userId | [optional] [default to undefined]
12
+ **type** | **string** | type | [optional] [default to undefined]
13
+ **note** | **string** | note | [optional] [default to undefined]
14
+ **timestamp** | **string** | timestamp | [optional] [default to undefined]
15
+ **journalTime** | **string** | journalTime | [optional] [default to undefined]
16
+ **duration** | **string** | duration | [optional] [default to undefined]
17
+ **callType** | **string** | callType | [optional] [default to undefined]
18
+ **callId** | **number** | callId | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { CrmNoteModel } from 'yellowgrid-api-ts';
24
+
25
+ const instance: CrmNoteModel = {
26
+ id,
27
+ customerId,
28
+ userId,
29
+ type,
30
+ note,
31
+ timestamp,
32
+ journalTime,
33
+ duration,
34
+ callType,
35
+ callId,
36
+ };
37
+ ```
38
+
39
+ [[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/NumberPortingApi.md CHANGED
@@ -401,7 +401,7 @@ No authorization required
401
401
  [[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)
402
402
 
403
403
  # **postAddAdminNote**
404
- > AdminNumberPortDTO postAddAdminNote(postAddAdminNoteRequest)
404
+ > AdminNumberPortDTO postAddAdminNote(postCreateCrmNoteRequest)
405
405
 
406
406
 
407
407
  ### Example
@@ -410,18 +410,18 @@ No authorization required
410
410
  import {
411
411
  NumberPortingApi,
412
412
  Configuration,
413
- PostAddAdminNoteRequest
413
+ PostCreateCrmNoteRequest
414
414
  } from 'yellowgrid-api-ts';
415
415
 
416
416
  const configuration = new Configuration();
417
417
  const apiInstance = new NumberPortingApi(configuration);
418
418
 
419
419
  let id: number; //Number Port ID (default to undefined)
420
- let postAddAdminNoteRequest: PostAddAdminNoteRequest; //
420
+ let postCreateCrmNoteRequest: PostCreateCrmNoteRequest; //
421
421
 
422
422
  const { status, data } = await apiInstance.postAddAdminNote(
423
423
  id,
424
- postAddAdminNoteRequest
424
+ postCreateCrmNoteRequest
425
425
  );
426
426
  ```
427
427
 
@@ -429,7 +429,7 @@ const { status, data } = await apiInstance.postAddAdminNote(
429
429
 
430
430
  |Name | Type | Description | Notes|
431
431
  |------------- | ------------- | ------------- | -------------|
432
- | **postAddAdminNoteRequest** | **PostAddAdminNoteRequest**| | |
432
+ | **postCreateCrmNoteRequest** | **PostCreateCrmNoteRequest**| | |
433
433
  | **id** | [**number**] | Number Port ID | defaults to undefined|
434
434
 
435
435
 
package/docs/PostCreateCrmNoteRequest.md ADDED
@@ -0,0 +1,20 @@
1
+ # PostCreateCrmNoteRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **note** | **string** | Note | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PostCreateCrmNoteRequest } from 'yellowgrid-api-ts';
14
+
15
+ const instance: PostCreateCrmNoteRequest = {
16
+ note,
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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.120-dev.0",
3
+ "version": "3.2.121-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {