yellowgrid-api-ts 3.2.247-dev.0 → 3.2.249-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 (27) hide show
  1. package/.openapi-generator/FILES +5 -0
  2. package/README.md +12 -0
  3. package/api.ts +789 -41
  4. package/dist/api.d.ts +453 -26
  5. package/dist/api.js +745 -51
  6. package/dist/models/ConnectionTypeEnum.d.ts +17 -7
  7. package/dist/models/ConnectionTypeEnum.js +17 -7
  8. package/dist/models/ReasonEnum.d.ts +2 -7
  9. package/dist/models/ReasonEnum.js +2 -7
  10. package/docs/AccountDetailedSummaryDTO.md +2 -0
  11. package/docs/AccountsApi.md +48 -0
  12. package/docs/AdminRmaDTO.md +2 -0
  13. package/docs/BillingApi.md +61 -6
  14. package/docs/OrdersApi.md +55 -0
  15. package/docs/PromoCodesEntity.md +11 -11
  16. package/docs/PromoItemModel.md +35 -0
  17. package/docs/PromoModel.md +45 -0
  18. package/docs/PromoSummariesModel.md +27 -0
  19. package/docs/PromoSummaryDTO.md +31 -0
  20. package/docs/PromotionsApi.md +241 -0
  21. package/docs/RMAApi.md +58 -0
  22. package/docs/RmaDTO.md +2 -0
  23. package/docs/RmaOrderDTO.md +4 -0
  24. package/docs/RmaRequestDTO.md +2 -0
  25. package/models/ConnectionTypeEnum.ts +17 -7
  26. package/models/ReasonEnum.ts +2 -7
  27. package/package.json +1 -1
package/docs/PromotionsApi.md ADDED
@@ -0,0 +1,241 @@
1
+ # PromotionsApi
2
+
3
+ All URIs are relative to *https://api.local.yellowgrid.co.uk*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getGetPromo**](#getgetpromo) | **GET** /marketing/promos/{id} | |
8
+ |[**getGetPromos**](#getgetpromos) | **GET** /marketing/promos | |
9
+ |[**postGetPromos**](#postgetpromos) | **POST** /marketing/promos | |
10
+ |[**putGetPromo**](#putgetpromo) | **PUT** /marketing/promos/{id} | |
11
+
12
+ # **getGetPromo**
13
+ > PromoModel getGetPromo()
14
+
15
+ Get a promotion
16
+
17
+ ### Example
18
+
19
+ ```typescript
20
+ import {
21
+ PromotionsApi,
22
+ Configuration
23
+ } from 'yellowgrid-api-ts';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new PromotionsApi(configuration);
27
+
28
+ let id: number; //Promo ID (default to undefined)
29
+
30
+ const { status, data } = await apiInstance.getGetPromo(
31
+ id
32
+ );
33
+ ```
34
+
35
+ ### Parameters
36
+
37
+ |Name | Type | Description | Notes|
38
+ |------------- | ------------- | ------------- | -------------|
39
+ | **id** | [**number**] | Promo ID | defaults to undefined|
40
+
41
+
42
+ ### Return type
43
+
44
+ **PromoModel**
45
+
46
+ ### Authorization
47
+
48
+ No authorization required
49
+
50
+ ### HTTP request headers
51
+
52
+ - **Content-Type**: Not defined
53
+ - **Accept**: application/json
54
+
55
+
56
+ ### HTTP response details
57
+ | Status code | Description | Response headers |
58
+ |-------------|-------------|------------------|
59
+ |**200** | Promotion | - |
60
+ |**400** | Bad Request | - |
61
+ |**401** | Unauthorised | - |
62
+ |**403** | Access Denied | - |
63
+
64
+ [[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)
65
+
66
+ # **getGetPromos**
67
+ > PromoSummariesModel getGetPromos()
68
+
69
+ Get Promos
70
+
71
+ ### Example
72
+
73
+ ```typescript
74
+ import {
75
+ PromotionsApi,
76
+ Configuration
77
+ } from 'yellowgrid-api-ts';
78
+
79
+ const configuration = new Configuration();
80
+ const apiInstance = new PromotionsApi(configuration);
81
+
82
+ let pageSize: number; //Number Of Results (optional) (default to 20)
83
+ let page: number; //Page Number (optional) (default to 1)
84
+ let search: string; //Search (optional) (default to undefined)
85
+ let expired: boolean; //Expired (optional) (default to undefined)
86
+
87
+ const { status, data } = await apiInstance.getGetPromos(
88
+ pageSize,
89
+ page,
90
+ search,
91
+ expired
92
+ );
93
+ ```
94
+
95
+ ### Parameters
96
+
97
+ |Name | Type | Description | Notes|
98
+ |------------- | ------------- | ------------- | -------------|
99
+ | **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
100
+ | **page** | [**number**] | Page Number | (optional) defaults to 1|
101
+ | **search** | [**string**] | Search | (optional) defaults to undefined|
102
+ | **expired** | [**boolean**] | Expired | (optional) defaults to undefined|
103
+
104
+
105
+ ### Return type
106
+
107
+ **PromoSummariesModel**
108
+
109
+ ### Authorization
110
+
111
+ No authorization required
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: application/json
117
+
118
+
119
+ ### HTTP response details
120
+ | Status code | Description | Response headers |
121
+ |-------------|-------------|------------------|
122
+ |**200** | Promo Summaries | - |
123
+ |**400** | Bad Request | - |
124
+ |**401** | Unauthorised | - |
125
+ |**403** | Access Denied | - |
126
+
127
+ [[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)
128
+
129
+ # **postGetPromos**
130
+ > PromoModel postGetPromos()
131
+
132
+ Create a promotion
133
+
134
+ ### Example
135
+
136
+ ```typescript
137
+ import {
138
+ PromotionsApi,
139
+ Configuration,
140
+ PromoModel
141
+ } from 'yellowgrid-api-ts';
142
+
143
+ const configuration = new Configuration();
144
+ const apiInstance = new PromotionsApi(configuration);
145
+
146
+ let promoModel: PromoModel; //Promotion (optional)
147
+
148
+ const { status, data } = await apiInstance.postGetPromos(
149
+ promoModel
150
+ );
151
+ ```
152
+
153
+ ### Parameters
154
+
155
+ |Name | Type | Description | Notes|
156
+ |------------- | ------------- | ------------- | -------------|
157
+ | **promoModel** | **PromoModel**| Promotion | |
158
+
159
+
160
+ ### Return type
161
+
162
+ **PromoModel**
163
+
164
+ ### Authorization
165
+
166
+ No authorization required
167
+
168
+ ### HTTP request headers
169
+
170
+ - **Content-Type**: application/json
171
+ - **Accept**: application/json
172
+
173
+
174
+ ### HTTP response details
175
+ | Status code | Description | Response headers |
176
+ |-------------|-------------|------------------|
177
+ |**200** | Promotion | - |
178
+ |**400** | Bad Request | - |
179
+ |**401** | Unauthorised | - |
180
+ |**403** | Access Denied | - |
181
+
182
+ [[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)
183
+
184
+ # **putGetPromo**
185
+ > PromoModel putGetPromo()
186
+
187
+ Update a promotion
188
+
189
+ ### Example
190
+
191
+ ```typescript
192
+ import {
193
+ PromotionsApi,
194
+ Configuration,
195
+ PromoModel
196
+ } from 'yellowgrid-api-ts';
197
+
198
+ const configuration = new Configuration();
199
+ const apiInstance = new PromotionsApi(configuration);
200
+
201
+ let id: number; //Promo ID (default to undefined)
202
+ let promoModel: PromoModel; //Promotion (optional)
203
+
204
+ const { status, data } = await apiInstance.putGetPromo(
205
+ id,
206
+ promoModel
207
+ );
208
+ ```
209
+
210
+ ### Parameters
211
+
212
+ |Name | Type | Description | Notes|
213
+ |------------- | ------------- | ------------- | -------------|
214
+ | **promoModel** | **PromoModel**| Promotion | |
215
+ | **id** | [**number**] | Promo ID | defaults to undefined|
216
+
217
+
218
+ ### Return type
219
+
220
+ **PromoModel**
221
+
222
+ ### Authorization
223
+
224
+ No authorization required
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: application/json
229
+ - **Accept**: application/json
230
+
231
+
232
+ ### HTTP response details
233
+ | Status code | Description | Response headers |
234
+ |-------------|-------------|------------------|
235
+ |**200** | Promotion | - |
236
+ |**400** | Bad Request | - |
237
+ |**401** | Unauthorised | - |
238
+ |**403** | Access Denied | - |
239
+
240
+ [[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)
241
+
package/docs/RMAApi.md CHANGED
@@ -12,6 +12,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
12
12
  |[**getGetAdminRmas**](#getgetadminrmas) | **GET** /admin/rma | |
13
13
  |[**getGetRma**](#getgetrma) | **GET** /rma/{id} | |
14
14
  |[**getGetRmaOrder**](#getgetrmaorder) | **GET** /rma/orders/{id} | |
15
+ |[**getSearchAdvanceReplacementOrders**](#getsearchadvancereplacementorders) | **GET** /rma/advance_replacement/orders | |
15
16
  |[**getSearchRmaOrders**](#getsearchrmaorders) | **GET** /rma/orders | |
16
17
  |[**patchApproveRma**](#patchapproverma) | **PATCH** /admin/rma/{id}/approve | |
17
18
  |[**patchMarkRmaItemAsBinned**](#patchmarkrmaitemasbinned) | **PATCH** /admin/rma/{id}/items/{item_id}/bin | |
@@ -481,6 +482,63 @@ No authorization required
481
482
 
482
483
  [[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)
483
484
 
485
+ # **getSearchAdvanceReplacementOrders**
486
+ > Array<RmaOrderSummaryDTO> getSearchAdvanceReplacementOrders()
487
+
488
+ Get suitable advance replacment orders
489
+
490
+ ### Example
491
+
492
+ ```typescript
493
+ import {
494
+ RMAApi,
495
+ Configuration
496
+ } from 'yellowgrid-api-ts';
497
+
498
+ const configuration = new Configuration();
499
+ const apiInstance = new RMAApi(configuration);
500
+
501
+ let sku: string; //Item SKU (default to undefined)
502
+ let orderId: number; //Order ID (default to undefined)
503
+
504
+ const { status, data } = await apiInstance.getSearchAdvanceReplacementOrders(
505
+ sku,
506
+ orderId
507
+ );
508
+ ```
509
+
510
+ ### Parameters
511
+
512
+ |Name | Type | Description | Notes|
513
+ |------------- | ------------- | ------------- | -------------|
514
+ | **sku** | [**string**] | Item SKU | defaults to undefined|
515
+ | **orderId** | [**number**] | Order ID | defaults to undefined|
516
+
517
+
518
+ ### Return type
519
+
520
+ **Array<RmaOrderSummaryDTO>**
521
+
522
+ ### Authorization
523
+
524
+ No authorization required
525
+
526
+ ### HTTP request headers
527
+
528
+ - **Content-Type**: Not defined
529
+ - **Accept**: application/json
530
+
531
+
532
+ ### HTTP response details
533
+ | Status code | Description | Response headers |
534
+ |-------------|-------------|------------------|
535
+ |**200** | Customer RMAs | - |
536
+ |**400** | Bad Request | - |
537
+ |**401** | Unauthorised | - |
538
+ |**403** | Access Denied | - |
539
+
540
+ [[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)
541
+
484
542
  # **getSearchRmaOrders**
485
543
  > Array<RmaOrderSummaryDTO> getSearchRmaOrders()
486
544
 
package/docs/RmaDTO.md CHANGED
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
18
18
  **statusText** | **string** | RMA Status Text | [default to undefined]
19
19
  **approved** | **boolean** | RMA Approval Status | [default to undefined]
20
20
  **address** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
21
+ **advanceReplacementOrderId** | **number** | Advance Replacement Order ID | [default to undefined]
21
22
  **items** | [**Array&lt;RmaItemDTO&gt;**](RmaItemDTO.md) | RMA Items | [default to undefined]
22
23
 
23
24
  ## Example
@@ -38,6 +39,7 @@ const instance: RmaDTO = {
38
39
  statusText,
39
40
  approved,
40
41
  address,
42
+ advanceReplacementOrderId,
41
43
  items,
42
44
  };
43
45
  ```
package/docs/RmaOrderDTO.md CHANGED
@@ -10,7 +10,9 @@ Name | Type | Description | Notes
10
10
  **reference** | **string** | Order Reference | [default to undefined]
11
11
  **orderDate** | **string** | Date Time | [default to undefined]
12
12
  **warrantyExpired** | **boolean** | Warranty Expired | [optional] [default to undefined]
13
+ **allowedCredit** | **boolean** | Allowed Credit | [optional] [default to undefined]
13
14
  **items** | [**Array&lt;RmaOrderItemDTO&gt;**](RmaOrderItemDTO.md) | RMA Order Items | [optional] [default to undefined]
15
+ **address** | [**AddressDTO**](AddressDTO.md) | | [optional] [default to undefined]
14
16
 
15
17
  ## Example
16
18
 
@@ -22,7 +24,9 @@ const instance: RmaOrderDTO = {
22
24
  reference,
23
25
  orderDate,
24
26
  warrantyExpired,
27
+ allowedCredit,
25
28
  items,
29
+ address,
26
30
  };
27
31
  ```
28
32
 
package/docs/RmaRequestDTO.md CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
13
13
  **requestedResolution** | **number** | RMA Resolution | [default to undefined]
14
14
  **items** | [**Array&lt;RmaItemRequestDTO&gt;**](RmaItemRequestDTO.md) | RMA Items | [default to undefined]
15
15
  **address** | [**AddressDTO**](AddressDTO.md) | | [default to undefined]
16
+ **advanceReplacementOrderId** | **number** | Advance Replacement Order ID | [default to undefined]
16
17
 
17
18
  ## Example
18
19
 
@@ -28,6 +29,7 @@ const instance: RmaRequestDTO = {
28
29
  requestedResolution,
29
30
  items,
30
31
  address,
32
+ advanceReplacementOrderId,
31
33
  };
32
34
  ```
33
35
 
package/models/ConnectionTypeEnum.ts CHANGED
@@ -39,8 +39,8 @@ export const ConnectionTypeEnum = {
39
39
  "value": "Hosting",
40
40
  "publicValue": "Hosting"
41
41
  },
42
- "CRM": {
43
- "name": "CRM",
42
+ "CRM_INTEGRATION": {
43
+ "name": "CRM_INTEGRATION",
44
44
  "value": "CRM",
45
45
  "publicValue": "CRM"
46
46
  },
@@ -49,15 +49,25 @@ export const ConnectionTypeEnum = {
49
49
  "value": "Starter Bundle",
50
50
  "publicValue": "Starter Bundle"
51
51
  },
52
- "OTHER": {
53
- "name": "OTHER",
54
- "value": "Other",
55
- "publicValue": "Other"
56
- },
57
52
  "RECURRING_CHARGES": {
58
53
  "name": "RECURRING_CHARGES",
59
54
  "value": "Recurring Charges",
60
55
  "publicValue": "Recurring Charges"
56
+ },
57
+ "TLN_SMS": {
58
+ "name": "TLN_SMS",
59
+ "value": "SMS",
60
+ "publicValue": "SMS"
61
+ },
62
+ "CFD": {
63
+ "name": "CFD",
64
+ "value": "CFD",
65
+ "publicValue": "CFD"
66
+ },
67
+ "ETP_CRM": {
68
+ "name": "ETP_CRM",
69
+ "value": "EdTechPro",
70
+ "publicValue": "EdTechPro"
61
71
  }
62
72
  } as const;
63
73
 
package/models/ReasonEnum.ts CHANGED
@@ -9,15 +9,10 @@ export const ReasonEnum = {
9
9
  "value": 2,
10
10
  "publicValue": "Faulty"
11
11
  },
12
- "WORKING_GOOD_CONDITION": {
13
- "name": "WORKING_GOOD_CONDITION",
12
+ "WORKING": {
13
+ "name": "WORKING",
14
14
  "value": 3,
15
15
  "publicValue": "Working (Good Condition)"
16
- },
17
- "WORKING_BAD_CONDITION": {
18
- "name": "WORKING_BAD_CONDITION",
19
- "value": 4,
20
- "publicValue": "Working (Bad Condition)"
21
16
  }
22
17
  } as const;
23
18
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yellowgrid-api-ts",
3
- "version": "3.2.247-dev.0",
3
+ "version": "3.2.249-dev.0",
4
4
  "description": "OpenAPI client for yellowgrid-api-ts",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {