ultracart_rest_api_v2_typescript 4.1.89 → 4.1.91
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 +4 -2
- package/dist/apis/WebhookApi.d.ts +24 -1
- package/dist/apis/WebhookApi.js +56 -0
- package/dist/models/ChannelPartnerOrder.d.ts +6 -0
- package/dist/models/ChannelPartnerOrder.js +2 -0
- package/dist/models/WebhookEventCategoriesResponse.d.ts +59 -0
- package/dist/models/WebhookEventCategoriesResponse.js +62 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/WebhookApi.ts +55 -0
- package/src/models/ChannelPartnerOrder.ts +8 -0
- package/src/models/WebhookEventCategoriesResponse.ts +124 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -980,6 +980,7 @@ src/models/UsersResponse.ts
|
|
|
980
980
|
src/models/VerificationRecord.ts
|
|
981
981
|
src/models/Warning.ts
|
|
982
982
|
src/models/Webhook.ts
|
|
983
|
+
src/models/WebhookEventCategoriesResponse.ts
|
|
983
984
|
src/models/WebhookEventCategory.ts
|
|
984
985
|
src/models/WebhookEventSubscription.ts
|
|
985
986
|
src/models/WebhookLog.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.91
|
|
3
3
|
|
|
4
4
|
Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
|
|
5
5
|
|
|
6
6
|
Installation
|
|
7
7
|
|
|
8
8
|
```
|
|
9
|
-
npm install ultracart_rest_api_v2_typescript@4.1.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.91 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.91 | 05/18/2026 | ChannelPartner - support creation_dts on import of a store_completed (historical) order |
|
|
89
|
+
| 4.1.90 | 05/13/2026 | webhook rest api - new method getWebhookEventCategories |
|
|
88
90
|
| 4.1.89 | 05/11/2026 | auto order item level webhooks - cancel scheduled, cancel, pause, reactive, and unpause |
|
|
89
91
|
| 4.1.88 | 05/08/2026 | order page view history |
|
|
90
92
|
| 4.1.87 | 05/08/2026 | order and auto order emails |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { Webhook, WebhookLogResponse, WebhookLogSummariesResponse, WebhookReflowResponse, WebhookResponse, WebhooksResponse } from '../models';
|
|
13
|
+
import { Webhook, WebhookEventCategoriesResponse, WebhookLogResponse, WebhookLogSummariesResponse, WebhookReflowResponse, WebhookResponse, WebhooksResponse } from '../models';
|
|
14
14
|
export interface DeleteWebhookRequest {
|
|
15
15
|
webhookOid: number;
|
|
16
16
|
}
|
|
@@ -81,6 +81,19 @@ export interface WebhookApiInterface {
|
|
|
81
81
|
* Delete a webhook by URL
|
|
82
82
|
*/
|
|
83
83
|
deleteWebhookByUrl(requestParameters: DeleteWebhookByUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
|
|
84
|
+
/**
|
|
85
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
86
|
+
* @summary Retrieve webhook event categories
|
|
87
|
+
* @param {*} [options] Override http request option.
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
* @memberof WebhookApiInterface
|
|
90
|
+
*/
|
|
91
|
+
getWebhookEventCategoriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEventCategoriesResponse>>;
|
|
92
|
+
/**
|
|
93
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
94
|
+
* Retrieve webhook event categories
|
|
95
|
+
*/
|
|
96
|
+
getWebhookEventCategories(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEventCategoriesResponse>;
|
|
84
97
|
/**
|
|
85
98
|
* Retrieves an individual log for a webhook given the webhook oid the request id.
|
|
86
99
|
* @summary Retrieve an individual log
|
|
@@ -201,6 +214,16 @@ export declare class WebhookApi extends runtime.BaseAPI implements WebhookApiInt
|
|
|
201
214
|
* Delete a webhook by URL
|
|
202
215
|
*/
|
|
203
216
|
deleteWebhookByUrl(requestParameters: DeleteWebhookByUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
|
|
217
|
+
/**
|
|
218
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
219
|
+
* Retrieve webhook event categories
|
|
220
|
+
*/
|
|
221
|
+
getWebhookEventCategoriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEventCategoriesResponse>>;
|
|
222
|
+
/**
|
|
223
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
224
|
+
* Retrieve webhook event categories
|
|
225
|
+
*/
|
|
226
|
+
getWebhookEventCategories(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEventCategoriesResponse>;
|
|
204
227
|
/**
|
|
205
228
|
* Retrieves an individual log for a webhook given the webhook oid the request id.
|
|
206
229
|
* Retrieve an individual log
|
package/dist/apis/WebhookApi.js
CHANGED
|
@@ -193,6 +193,62 @@ var WebhookApi = /** @class */ (function (_super) {
|
|
|
193
193
|
});
|
|
194
194
|
});
|
|
195
195
|
};
|
|
196
|
+
/**
|
|
197
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
198
|
+
* Retrieve webhook event categories
|
|
199
|
+
*/
|
|
200
|
+
WebhookApi.prototype.getWebhookEventCategoriesRaw = function (initOverrides) {
|
|
201
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
202
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
203
|
+
return __generator(this, function (_c) {
|
|
204
|
+
switch (_c.label) {
|
|
205
|
+
case 0:
|
|
206
|
+
queryParameters = {};
|
|
207
|
+
headerParameters = {};
|
|
208
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
209
|
+
// oauth required
|
|
210
|
+
_a = headerParameters;
|
|
211
|
+
_b = "Authorization";
|
|
212
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["webhook_read"])];
|
|
213
|
+
case 1:
|
|
214
|
+
// oauth required
|
|
215
|
+
_a[_b] = _c.sent();
|
|
216
|
+
_c.label = 2;
|
|
217
|
+
case 2:
|
|
218
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
219
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
220
|
+
}
|
|
221
|
+
return [4 /*yield*/, this.request({
|
|
222
|
+
path: "/webhook/webhook_event_categories",
|
|
223
|
+
method: 'GET',
|
|
224
|
+
headers: headerParameters,
|
|
225
|
+
query: queryParameters,
|
|
226
|
+
}, initOverrides)];
|
|
227
|
+
case 3:
|
|
228
|
+
response = _c.sent();
|
|
229
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.WebhookEventCategoriesResponseFromJSON)(jsonValue); })];
|
|
230
|
+
}
|
|
231
|
+
});
|
|
232
|
+
});
|
|
233
|
+
};
|
|
234
|
+
/**
|
|
235
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
236
|
+
* Retrieve webhook event categories
|
|
237
|
+
*/
|
|
238
|
+
WebhookApi.prototype.getWebhookEventCategories = function (initOverrides) {
|
|
239
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
240
|
+
var response;
|
|
241
|
+
return __generator(this, function (_a) {
|
|
242
|
+
switch (_a.label) {
|
|
243
|
+
case 0: return [4 /*yield*/, this.getWebhookEventCategoriesRaw(initOverrides)];
|
|
244
|
+
case 1:
|
|
245
|
+
response = _a.sent();
|
|
246
|
+
return [4 /*yield*/, response.value()];
|
|
247
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
248
|
+
}
|
|
249
|
+
});
|
|
250
|
+
});
|
|
251
|
+
};
|
|
196
252
|
/**
|
|
197
253
|
* Retrieves an individual log for a webhook given the webhook oid the request id.
|
|
198
254
|
* Retrieve an individual log
|
|
@@ -167,6 +167,12 @@ export interface ChannelPartnerOrder {
|
|
|
167
167
|
* @memberof ChannelPartnerOrder
|
|
168
168
|
*/
|
|
169
169
|
coupons?: Array<string>;
|
|
170
|
+
/**
|
|
171
|
+
* Date/time the original order was placed on the channel partner's system, in ISO8601 format. Only honored when store_completed is true (historical order imports). Rejected on live orders.
|
|
172
|
+
* @type {string}
|
|
173
|
+
* @memberof ChannelPartnerOrder
|
|
174
|
+
*/
|
|
175
|
+
creation_dts?: string;
|
|
170
176
|
/**
|
|
171
177
|
* The amount authorized externally
|
|
172
178
|
* @type {number}
|
|
@@ -91,6 +91,7 @@ function ChannelPartnerOrderFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
91
91
|
'channel_partner_order_id': !(0, runtime_1.exists)(json, 'channel_partner_order_id') ? undefined : json['channel_partner_order_id'],
|
|
92
92
|
'consider_recurring': !(0, runtime_1.exists)(json, 'consider_recurring') ? undefined : json['consider_recurring'],
|
|
93
93
|
'coupons': !(0, runtime_1.exists)(json, 'coupons') ? undefined : json['coupons'],
|
|
94
|
+
'creation_dts': !(0, runtime_1.exists)(json, 'creation_dts') ? undefined : json['creation_dts'],
|
|
94
95
|
'credit_card_authorization_amount': !(0, runtime_1.exists)(json, 'credit_card_authorization_amount') ? undefined : json['credit_card_authorization_amount'],
|
|
95
96
|
'credit_card_authorization_dts': !(0, runtime_1.exists)(json, 'credit_card_authorization_dts') ? undefined : json['credit_card_authorization_dts'],
|
|
96
97
|
'credit_card_authorization_number': !(0, runtime_1.exists)(json, 'credit_card_authorization_number') ? undefined : json['credit_card_authorization_number'],
|
|
@@ -195,6 +196,7 @@ function ChannelPartnerOrderToJSON(value) {
|
|
|
195
196
|
'channel_partner_order_id': value.channel_partner_order_id,
|
|
196
197
|
'consider_recurring': value.consider_recurring,
|
|
197
198
|
'coupons': value.coupons,
|
|
199
|
+
'creation_dts': value.creation_dts,
|
|
198
200
|
'credit_card_authorization_amount': value.credit_card_authorization_amount,
|
|
199
201
|
'credit_card_authorization_dts': value.credit_card_authorization_dts,
|
|
200
202
|
'credit_card_authorization_number': value.credit_card_authorization_number,
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { ModelError } from './ModelError';
|
|
13
|
+
import { ResponseMetadata } from './ResponseMetadata';
|
|
14
|
+
import { Warning } from './Warning';
|
|
15
|
+
import { WebhookEventCategory } from './WebhookEventCategory';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface WebhookEventCategoriesResponse
|
|
20
|
+
*/
|
|
21
|
+
export interface WebhookEventCategoriesResponse {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {ModelError}
|
|
25
|
+
* @memberof WebhookEventCategoriesResponse
|
|
26
|
+
*/
|
|
27
|
+
error?: ModelError;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {Array<WebhookEventCategory>}
|
|
31
|
+
* @memberof WebhookEventCategoriesResponse
|
|
32
|
+
*/
|
|
33
|
+
event_categories?: Array<WebhookEventCategory>;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {ResponseMetadata}
|
|
37
|
+
* @memberof WebhookEventCategoriesResponse
|
|
38
|
+
*/
|
|
39
|
+
metadata?: ResponseMetadata;
|
|
40
|
+
/**
|
|
41
|
+
* Indicates if API call was successful
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof WebhookEventCategoriesResponse
|
|
44
|
+
*/
|
|
45
|
+
success?: boolean;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {Warning}
|
|
49
|
+
* @memberof WebhookEventCategoriesResponse
|
|
50
|
+
*/
|
|
51
|
+
warning?: Warning;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Check if a given object implements the WebhookEventCategoriesResponse interface.
|
|
55
|
+
*/
|
|
56
|
+
export declare function instanceOfWebhookEventCategoriesResponse(value: object): boolean;
|
|
57
|
+
export declare function WebhookEventCategoriesResponseFromJSON(json: any): WebhookEventCategoriesResponse;
|
|
58
|
+
export declare function WebhookEventCategoriesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEventCategoriesResponse;
|
|
59
|
+
export declare function WebhookEventCategoriesResponseToJSON(value?: WebhookEventCategoriesResponse | null): any;
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.WebhookEventCategoriesResponseToJSON = exports.WebhookEventCategoriesResponseFromJSONTyped = exports.WebhookEventCategoriesResponseFromJSON = exports.instanceOfWebhookEventCategoriesResponse = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var ModelError_1 = require("./ModelError");
|
|
19
|
+
var ResponseMetadata_1 = require("./ResponseMetadata");
|
|
20
|
+
var Warning_1 = require("./Warning");
|
|
21
|
+
var WebhookEventCategory_1 = require("./WebhookEventCategory");
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the WebhookEventCategoriesResponse interface.
|
|
24
|
+
*/
|
|
25
|
+
function instanceOfWebhookEventCategoriesResponse(value) {
|
|
26
|
+
var isInstance = true;
|
|
27
|
+
return isInstance;
|
|
28
|
+
}
|
|
29
|
+
exports.instanceOfWebhookEventCategoriesResponse = instanceOfWebhookEventCategoriesResponse;
|
|
30
|
+
function WebhookEventCategoriesResponseFromJSON(json) {
|
|
31
|
+
return WebhookEventCategoriesResponseFromJSONTyped(json, false);
|
|
32
|
+
}
|
|
33
|
+
exports.WebhookEventCategoriesResponseFromJSON = WebhookEventCategoriesResponseFromJSON;
|
|
34
|
+
function WebhookEventCategoriesResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
35
|
+
if ((json === undefined) || (json === null)) {
|
|
36
|
+
return json;
|
|
37
|
+
}
|
|
38
|
+
return {
|
|
39
|
+
'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
|
|
40
|
+
'event_categories': !(0, runtime_1.exists)(json, 'event_categories') ? undefined : (json['event_categories'].map(WebhookEventCategory_1.WebhookEventCategoryFromJSON)),
|
|
41
|
+
'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
|
|
42
|
+
'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
|
|
43
|
+
'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
exports.WebhookEventCategoriesResponseFromJSONTyped = WebhookEventCategoriesResponseFromJSONTyped;
|
|
47
|
+
function WebhookEventCategoriesResponseToJSON(value) {
|
|
48
|
+
if (value === undefined) {
|
|
49
|
+
return undefined;
|
|
50
|
+
}
|
|
51
|
+
if (value === null) {
|
|
52
|
+
return null;
|
|
53
|
+
}
|
|
54
|
+
return {
|
|
55
|
+
'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
|
|
56
|
+
'event_categories': value.event_categories === undefined ? undefined : (value.event_categories.map(WebhookEventCategory_1.WebhookEventCategoryToJSON)),
|
|
57
|
+
'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
|
|
58
|
+
'success': value.success,
|
|
59
|
+
'warning': (0, Warning_1.WarningToJSON)(value.warning),
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
exports.WebhookEventCategoriesResponseToJSON = WebhookEventCategoriesResponseToJSON;
|
package/dist/models/index.d.ts
CHANGED
|
@@ -953,6 +953,7 @@ export * from './UsersResponse';
|
|
|
953
953
|
export * from './VerificationRecord';
|
|
954
954
|
export * from './Warning';
|
|
955
955
|
export * from './Webhook';
|
|
956
|
+
export * from './WebhookEventCategoriesResponse';
|
|
956
957
|
export * from './WebhookEventCategory';
|
|
957
958
|
export * from './WebhookEventSubscription';
|
|
958
959
|
export * from './WebhookLog';
|
package/dist/models/index.js
CHANGED
|
@@ -971,6 +971,7 @@ __exportStar(require("./UsersResponse"), exports);
|
|
|
971
971
|
__exportStar(require("./VerificationRecord"), exports);
|
|
972
972
|
__exportStar(require("./Warning"), exports);
|
|
973
973
|
__exportStar(require("./Webhook"), exports);
|
|
974
|
+
__exportStar(require("./WebhookEventCategoriesResponse"), exports);
|
|
974
975
|
__exportStar(require("./WebhookEventCategory"), exports);
|
|
975
976
|
__exportStar(require("./WebhookEventSubscription"), exports);
|
|
976
977
|
__exportStar(require("./WebhookLog"), exports);
|
package/package.json
CHANGED
package/src/apis/WebhookApi.ts
CHANGED
|
@@ -21,6 +21,9 @@ import {
|
|
|
21
21
|
Webhook,
|
|
22
22
|
WebhookFromJSON,
|
|
23
23
|
WebhookToJSON,
|
|
24
|
+
WebhookEventCategoriesResponse,
|
|
25
|
+
WebhookEventCategoriesResponseFromJSON,
|
|
26
|
+
WebhookEventCategoriesResponseToJSON,
|
|
24
27
|
WebhookLogResponse,
|
|
25
28
|
WebhookLogResponseFromJSON,
|
|
26
29
|
WebhookLogResponseToJSON,
|
|
@@ -120,6 +123,21 @@ export interface WebhookApiInterface {
|
|
|
120
123
|
*/
|
|
121
124
|
deleteWebhookByUrl(requestParameters: DeleteWebhookByUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookResponse>;
|
|
122
125
|
|
|
126
|
+
/**
|
|
127
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
128
|
+
* @summary Retrieve webhook event categories
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
* @memberof WebhookApiInterface
|
|
132
|
+
*/
|
|
133
|
+
getWebhookEventCategoriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEventCategoriesResponse>>;
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
137
|
+
* Retrieve webhook event categories
|
|
138
|
+
*/
|
|
139
|
+
getWebhookEventCategories(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEventCategoriesResponse>;
|
|
140
|
+
|
|
123
141
|
/**
|
|
124
142
|
* Retrieves an individual log for a webhook given the webhook oid the request id.
|
|
125
143
|
* @summary Retrieve an individual log
|
|
@@ -318,6 +336,43 @@ export class WebhookApi extends runtime.BaseAPI implements WebhookApiInterface {
|
|
|
318
336
|
return await response.value();
|
|
319
337
|
}
|
|
320
338
|
|
|
339
|
+
/**
|
|
340
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
341
|
+
* Retrieve webhook event categories
|
|
342
|
+
*/
|
|
343
|
+
async getWebhookEventCategoriesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WebhookEventCategoriesResponse>> {
|
|
344
|
+
const queryParameters: any = {};
|
|
345
|
+
|
|
346
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
347
|
+
|
|
348
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
349
|
+
// oauth required
|
|
350
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["webhook_read"]);
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
354
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
const response = await this.request({
|
|
358
|
+
path: `/webhook/webhook_event_categories`,
|
|
359
|
+
method: 'GET',
|
|
360
|
+
headers: headerParameters,
|
|
361
|
+
query: queryParameters,
|
|
362
|
+
}, initOverrides);
|
|
363
|
+
|
|
364
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => WebhookEventCategoriesResponseFromJSON(jsonValue));
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
/**
|
|
368
|
+
* Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.
|
|
369
|
+
* Retrieve webhook event categories
|
|
370
|
+
*/
|
|
371
|
+
async getWebhookEventCategories(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WebhookEventCategoriesResponse> {
|
|
372
|
+
const response = await this.getWebhookEventCategoriesRaw(initOverrides);
|
|
373
|
+
return await response.value();
|
|
374
|
+
}
|
|
375
|
+
|
|
321
376
|
/**
|
|
322
377
|
* Retrieves an individual log for a webhook given the webhook oid the request id.
|
|
323
378
|
* Retrieve an individual log
|
|
@@ -182,6 +182,12 @@ export interface ChannelPartnerOrder {
|
|
|
182
182
|
* @memberof ChannelPartnerOrder
|
|
183
183
|
*/
|
|
184
184
|
coupons?: Array<string>;
|
|
185
|
+
/**
|
|
186
|
+
* Date/time the original order was placed on the channel partner's system, in ISO8601 format. Only honored when store_completed is true (historical order imports). Rejected on live orders.
|
|
187
|
+
* @type {string}
|
|
188
|
+
* @memberof ChannelPartnerOrder
|
|
189
|
+
*/
|
|
190
|
+
creation_dts?: string;
|
|
185
191
|
/**
|
|
186
192
|
* The amount authorized externally
|
|
187
193
|
* @type {number}
|
|
@@ -677,6 +683,7 @@ export function ChannelPartnerOrderFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
677
683
|
'channel_partner_order_id': !exists(json, 'channel_partner_order_id') ? undefined : json['channel_partner_order_id'],
|
|
678
684
|
'consider_recurring': !exists(json, 'consider_recurring') ? undefined : json['consider_recurring'],
|
|
679
685
|
'coupons': !exists(json, 'coupons') ? undefined : json['coupons'],
|
|
686
|
+
'creation_dts': !exists(json, 'creation_dts') ? undefined : json['creation_dts'],
|
|
680
687
|
'credit_card_authorization_amount': !exists(json, 'credit_card_authorization_amount') ? undefined : json['credit_card_authorization_amount'],
|
|
681
688
|
'credit_card_authorization_dts': !exists(json, 'credit_card_authorization_dts') ? undefined : json['credit_card_authorization_dts'],
|
|
682
689
|
'credit_card_authorization_number': !exists(json, 'credit_card_authorization_number') ? undefined : json['credit_card_authorization_number'],
|
|
@@ -782,6 +789,7 @@ export function ChannelPartnerOrderToJSON(value?: ChannelPartnerOrder | null): a
|
|
|
782
789
|
'channel_partner_order_id': value.channel_partner_order_id,
|
|
783
790
|
'consider_recurring': value.consider_recurring,
|
|
784
791
|
'coupons': value.coupons,
|
|
792
|
+
'creation_dts': value.creation_dts,
|
|
785
793
|
'credit_card_authorization_amount': value.credit_card_authorization_amount,
|
|
786
794
|
'credit_card_authorization_dts': value.credit_card_authorization_dts,
|
|
787
795
|
'credit_card_authorization_number': value.credit_card_authorization_number,
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
ModelError,
|
|
18
|
+
ModelErrorFromJSON,
|
|
19
|
+
ModelErrorFromJSONTyped,
|
|
20
|
+
ModelErrorToJSON,
|
|
21
|
+
} from './ModelError';
|
|
22
|
+
import {
|
|
23
|
+
ResponseMetadata,
|
|
24
|
+
ResponseMetadataFromJSON,
|
|
25
|
+
ResponseMetadataFromJSONTyped,
|
|
26
|
+
ResponseMetadataToJSON,
|
|
27
|
+
} from './ResponseMetadata';
|
|
28
|
+
import {
|
|
29
|
+
Warning,
|
|
30
|
+
WarningFromJSON,
|
|
31
|
+
WarningFromJSONTyped,
|
|
32
|
+
WarningToJSON,
|
|
33
|
+
} from './Warning';
|
|
34
|
+
import {
|
|
35
|
+
WebhookEventCategory,
|
|
36
|
+
WebhookEventCategoryFromJSON,
|
|
37
|
+
WebhookEventCategoryFromJSONTyped,
|
|
38
|
+
WebhookEventCategoryToJSON,
|
|
39
|
+
} from './WebhookEventCategory';
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
* @interface WebhookEventCategoriesResponse
|
|
45
|
+
*/
|
|
46
|
+
export interface WebhookEventCategoriesResponse {
|
|
47
|
+
/**
|
|
48
|
+
*
|
|
49
|
+
* @type {ModelError}
|
|
50
|
+
* @memberof WebhookEventCategoriesResponse
|
|
51
|
+
*/
|
|
52
|
+
error?: ModelError;
|
|
53
|
+
/**
|
|
54
|
+
*
|
|
55
|
+
* @type {Array<WebhookEventCategory>}
|
|
56
|
+
* @memberof WebhookEventCategoriesResponse
|
|
57
|
+
*/
|
|
58
|
+
event_categories?: Array<WebhookEventCategory>;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @type {ResponseMetadata}
|
|
62
|
+
* @memberof WebhookEventCategoriesResponse
|
|
63
|
+
*/
|
|
64
|
+
metadata?: ResponseMetadata;
|
|
65
|
+
/**
|
|
66
|
+
* Indicates if API call was successful
|
|
67
|
+
* @type {boolean}
|
|
68
|
+
* @memberof WebhookEventCategoriesResponse
|
|
69
|
+
*/
|
|
70
|
+
success?: boolean;
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @type {Warning}
|
|
74
|
+
* @memberof WebhookEventCategoriesResponse
|
|
75
|
+
*/
|
|
76
|
+
warning?: Warning;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Check if a given object implements the WebhookEventCategoriesResponse interface.
|
|
83
|
+
*/
|
|
84
|
+
export function instanceOfWebhookEventCategoriesResponse(value: object): boolean {
|
|
85
|
+
let isInstance = true;
|
|
86
|
+
|
|
87
|
+
return isInstance;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export function WebhookEventCategoriesResponseFromJSON(json: any): WebhookEventCategoriesResponse {
|
|
91
|
+
return WebhookEventCategoriesResponseFromJSONTyped(json, false);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
export function WebhookEventCategoriesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookEventCategoriesResponse {
|
|
95
|
+
if ((json === undefined) || (json === null)) {
|
|
96
|
+
return json;
|
|
97
|
+
}
|
|
98
|
+
return {
|
|
99
|
+
|
|
100
|
+
'error': !exists(json, 'error') ? undefined : ModelErrorFromJSON(json['error']),
|
|
101
|
+
'event_categories': !exists(json, 'event_categories') ? undefined : ((json['event_categories'] as Array<any>).map(WebhookEventCategoryFromJSON)),
|
|
102
|
+
'metadata': !exists(json, 'metadata') ? undefined : ResponseMetadataFromJSON(json['metadata']),
|
|
103
|
+
'success': !exists(json, 'success') ? undefined : json['success'],
|
|
104
|
+
'warning': !exists(json, 'warning') ? undefined : WarningFromJSON(json['warning']),
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export function WebhookEventCategoriesResponseToJSON(value?: WebhookEventCategoriesResponse | null): any {
|
|
109
|
+
if (value === undefined) {
|
|
110
|
+
return undefined;
|
|
111
|
+
}
|
|
112
|
+
if (value === null) {
|
|
113
|
+
return null;
|
|
114
|
+
}
|
|
115
|
+
return {
|
|
116
|
+
|
|
117
|
+
'error': ModelErrorToJSON(value.error),
|
|
118
|
+
'event_categories': value.event_categories === undefined ? undefined : ((value.event_categories as Array<any>).map(WebhookEventCategoryToJSON)),
|
|
119
|
+
'metadata': ResponseMetadataToJSON(value.metadata),
|
|
120
|
+
'success': value.success,
|
|
121
|
+
'warning': WarningToJSON(value.warning),
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -955,6 +955,7 @@ export * from './UsersResponse';
|
|
|
955
955
|
export * from './VerificationRecord';
|
|
956
956
|
export * from './Warning';
|
|
957
957
|
export * from './Webhook';
|
|
958
|
+
export * from './WebhookEventCategoriesResponse';
|
|
958
959
|
export * from './WebhookEventCategory';
|
|
959
960
|
export * from './WebhookEventSubscription';
|
|
960
961
|
export * from './WebhookLog';
|