ultracart_rest_api_v2_typescript 4.1.211 → 4.1.213
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/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +4 -4
- package/dist/apis/SfvbApi.js +2 -2
- package/dist/models/AutoOrderItem.d.ts +3 -3
- package/dist/models/ConversationAgentAuth.d.ts +14 -0
- package/dist/models/ConversationAgentAuth.js +10 -1
- package/dist/models/ConversationPbxAgent.d.ts +14 -0
- package/dist/models/ConversationPbxAgent.js +10 -1
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +4 -4
- package/src/models/AutoOrderItem.ts +3 -3
- package/src/models/ConversationAgentAuth.ts +18 -0
- package/src/models/ConversationPbxAgent.ts +17 -0
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.213
|
|
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.213 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
|
|
|
84
84
|
|
|
85
85
|
| Version | Date | Comments |
|
|
86
86
|
| --: | :-: | --- |
|
|
87
|
+
| 4.1.213 | 10/28/2026 | auto order - improve item field descriptions |
|
|
88
|
+
| 4.1.212 | 10/27/2026 | conversation - pbx agent startup activity |
|
|
87
89
|
| 4.1.211 | 10/27/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.210 | 10/27/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.209 | 10/27/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -3715,7 +3715,7 @@ export interface SfvbApiInterface {
|
|
|
3715
3715
|
*/
|
|
3716
3716
|
revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
3717
3717
|
/**
|
|
3718
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
3718
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
3719
3719
|
* @summary Request a content review of a flow or campaign email
|
|
3720
3720
|
* @param {number} storefrontOid
|
|
3721
3721
|
* @param {string} emailUuid
|
|
@@ -3726,7 +3726,7 @@ export interface SfvbApiInterface {
|
|
|
3726
3726
|
*/
|
|
3727
3727
|
reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
3728
3728
|
/**
|
|
3729
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
3729
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
3730
3730
|
* Request a content review of a flow or campaign email
|
|
3731
3731
|
*/
|
|
3732
3732
|
reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
@@ -5906,12 +5906,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5906
5906
|
*/
|
|
5907
5907
|
revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
5908
5908
|
/**
|
|
5909
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
5909
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
5910
5910
|
* Request a content review of a flow or campaign email
|
|
5911
5911
|
*/
|
|
5912
5912
|
reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
5913
5913
|
/**
|
|
5914
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
5914
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
5915
5915
|
* Request a content review of a flow or campaign email
|
|
5916
5916
|
*/
|
|
5917
5917
|
reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
package/dist/apis/SfvbApi.js
CHANGED
|
@@ -11535,7 +11535,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
11535
11535
|
});
|
|
11536
11536
|
};
|
|
11537
11537
|
/**
|
|
11538
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
11538
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
11539
11539
|
* Request a content review of a flow or campaign email
|
|
11540
11540
|
*/
|
|
11541
11541
|
SfvbApi.prototype.reviewSfvbEmailRaw = function (requestParameters, initOverrides) {
|
|
@@ -11584,7 +11584,7 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
11584
11584
|
});
|
|
11585
11585
|
};
|
|
11586
11586
|
/**
|
|
11587
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
11587
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
11588
11588
|
* Request a content review of a flow or campaign email
|
|
11589
11589
|
*/
|
|
11590
11590
|
SfvbApi.prototype.reviewSfvbEmail = function (requestParameters, initOverrides) {
|
|
@@ -39,7 +39,7 @@ export interface AutoOrderItem {
|
|
|
39
39
|
*/
|
|
40
40
|
arbitrary_percentage_discount?: number;
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
42
|
+
* Quantity to rebill. When set, every rebill uses this quantity instead of original_quantity. Set this field to change the quantity on an active auto order; the merchant auto order editor updates this same field. Each rebill charges the unit price multiplied by this quantity.
|
|
43
43
|
* @type {number}
|
|
44
44
|
* @memberof AutoOrderItem
|
|
45
45
|
*/
|
|
@@ -51,7 +51,7 @@ export interface AutoOrderItem {
|
|
|
51
51
|
*/
|
|
52
52
|
arbitrary_schedule_days?: number;
|
|
53
53
|
/**
|
|
54
|
-
* Arbitrary unit cost that rebills of this item should occur at
|
|
54
|
+
* Arbitrary unit cost that rebills of this item should occur at. This is a price per unit. Each rebill charges it multiplied by the rebill quantity (arbitrary_quantity, or original_quantity when arbitrary_quantity is null).
|
|
55
55
|
* @type {number}
|
|
56
56
|
* @memberof AutoOrderItem
|
|
57
57
|
*/
|
|
@@ -159,7 +159,7 @@ export interface AutoOrderItem {
|
|
|
159
159
|
*/
|
|
160
160
|
original_item_id?: string;
|
|
161
161
|
/**
|
|
162
|
-
* The original quantity
|
|
162
|
+
* The quantity purchased on the original order. Rebills use this quantity only when arbitrary_quantity is null. To change the quantity on future rebills, set arbitrary_quantity instead.
|
|
163
163
|
* @type {number}
|
|
164
164
|
* @memberof AutoOrderItem
|
|
165
165
|
*/
|
|
@@ -95,6 +95,12 @@ export interface ConversationAgentAuth {
|
|
|
95
95
|
* @memberof ConversationAgentAuth
|
|
96
96
|
*/
|
|
97
97
|
pbx_jwt?: string;
|
|
98
|
+
/**
|
|
99
|
+
* Status the agent starts in when the CRM loads
|
|
100
|
+
* @type {string}
|
|
101
|
+
* @memberof ConversationAgentAuth
|
|
102
|
+
*/
|
|
103
|
+
pbx_startup_activity?: ConversationAgentAuthPbxStartupActivityEnum;
|
|
98
104
|
/**
|
|
99
105
|
*
|
|
100
106
|
* @type {boolean}
|
|
@@ -150,6 +156,14 @@ export interface ConversationAgentAuth {
|
|
|
150
156
|
*/
|
|
151
157
|
websocket_url?: string;
|
|
152
158
|
}
|
|
159
|
+
/**
|
|
160
|
+
* @export
|
|
161
|
+
*/
|
|
162
|
+
export declare const ConversationAgentAuthPbxStartupActivityEnum: {
|
|
163
|
+
readonly Available: "available";
|
|
164
|
+
readonly Unavailable: "unavailable";
|
|
165
|
+
};
|
|
166
|
+
export type ConversationAgentAuthPbxStartupActivityEnum = typeof ConversationAgentAuthPbxStartupActivityEnum[keyof typeof ConversationAgentAuthPbxStartupActivityEnum];
|
|
153
167
|
/**
|
|
154
168
|
* Check if a given object implements the ConversationAgentAuth interface.
|
|
155
169
|
*/
|
|
@@ -13,10 +13,17 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.ConversationAgentAuthToJSON = exports.ConversationAgentAuthFromJSONTyped = exports.ConversationAgentAuthFromJSON = exports.instanceOfConversationAgentAuth = void 0;
|
|
16
|
+
exports.ConversationAgentAuthToJSON = exports.ConversationAgentAuthFromJSONTyped = exports.ConversationAgentAuthFromJSON = exports.instanceOfConversationAgentAuth = exports.ConversationAgentAuthPbxStartupActivityEnum = void 0;
|
|
17
17
|
var runtime_1 = require("../runtime");
|
|
18
18
|
var ConversationAgentAuthMerchant_1 = require("./ConversationAgentAuthMerchant");
|
|
19
19
|
var ConversationTwilioAccount_1 = require("./ConversationTwilioAccount");
|
|
20
|
+
/**
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
exports.ConversationAgentAuthPbxStartupActivityEnum = {
|
|
24
|
+
Available: 'available',
|
|
25
|
+
Unavailable: 'unavailable'
|
|
26
|
+
};
|
|
20
27
|
/**
|
|
21
28
|
* Check if a given object implements the ConversationAgentAuth interface.
|
|
22
29
|
*/
|
|
@@ -47,6 +54,7 @@ function ConversationAgentAuthFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
54
|
'parent_merchant_id': !(0, runtime_1.exists)(json, 'parent_merchant_id') ? undefined : json['parent_merchant_id'],
|
|
48
55
|
'pbx_admin': !(0, runtime_1.exists)(json, 'pbx_admin') ? undefined : json['pbx_admin'],
|
|
49
56
|
'pbx_jwt': !(0, runtime_1.exists)(json, 'pbx_jwt') ? undefined : json['pbx_jwt'],
|
|
57
|
+
'pbx_startup_activity': !(0, runtime_1.exists)(json, 'pbx_startup_activity') ? undefined : json['pbx_startup_activity'],
|
|
50
58
|
'pbx_supervisor': !(0, runtime_1.exists)(json, 'pbx_supervisor') ? undefined : json['pbx_supervisor'],
|
|
51
59
|
'pbx_user': !(0, runtime_1.exists)(json, 'pbx_user') ? undefined : json['pbx_user'],
|
|
52
60
|
'pbx_voice_identity': !(0, runtime_1.exists)(json, 'pbx_voice_identity') ? undefined : json['pbx_voice_identity'],
|
|
@@ -80,6 +88,7 @@ function ConversationAgentAuthToJSON(value) {
|
|
|
80
88
|
'parent_merchant_id': value.parent_merchant_id,
|
|
81
89
|
'pbx_admin': value.pbx_admin,
|
|
82
90
|
'pbx_jwt': value.pbx_jwt,
|
|
91
|
+
'pbx_startup_activity': value.pbx_startup_activity,
|
|
83
92
|
'pbx_supervisor': value.pbx_supervisor,
|
|
84
93
|
'pbx_user': value.pbx_user,
|
|
85
94
|
'pbx_voice_identity': value.pbx_voice_identity,
|
|
@@ -105,6 +105,12 @@ export interface ConversationPbxAgent {
|
|
|
105
105
|
* @memberof ConversationPbxAgent
|
|
106
106
|
*/
|
|
107
107
|
shared_conversation_pbx_voicemail_mailbox_uuid?: string;
|
|
108
|
+
/**
|
|
109
|
+
* Status the agent starts in when the CRM loads. Missing means available.
|
|
110
|
+
* @type {string}
|
|
111
|
+
* @memberof ConversationPbxAgent
|
|
112
|
+
*/
|
|
113
|
+
startup_activity?: ConversationPbxAgentStartupActivityEnum;
|
|
108
114
|
/**
|
|
109
115
|
* Twilio taskrouter worker Id
|
|
110
116
|
* @type {string}
|
|
@@ -163,6 +169,14 @@ export declare const ConversationPbxAgentCallRoutingPreferenceEnum: {
|
|
|
163
169
|
readonly Cellphone: "cellphone";
|
|
164
170
|
};
|
|
165
171
|
export type ConversationPbxAgentCallRoutingPreferenceEnum = typeof ConversationPbxAgentCallRoutingPreferenceEnum[keyof typeof ConversationPbxAgentCallRoutingPreferenceEnum];
|
|
172
|
+
/**
|
|
173
|
+
* @export
|
|
174
|
+
*/
|
|
175
|
+
export declare const ConversationPbxAgentStartupActivityEnum: {
|
|
176
|
+
readonly Available: "available";
|
|
177
|
+
readonly Unavailable: "unavailable";
|
|
178
|
+
};
|
|
179
|
+
export type ConversationPbxAgentStartupActivityEnum = typeof ConversationPbxAgentStartupActivityEnum[keyof typeof ConversationPbxAgentStartupActivityEnum];
|
|
166
180
|
/**
|
|
167
181
|
* @export
|
|
168
182
|
*/
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
* Do not edit the class manually.
|
|
14
14
|
*/
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
-
exports.ConversationPbxAgentToJSON = exports.ConversationPbxAgentFromJSONTyped = exports.ConversationPbxAgentFromJSON = exports.instanceOfConversationPbxAgent = exports.ConversationPbxAgentUnavailableSayVoiceEnum = exports.ConversationPbxAgentCallRoutingPreferenceEnum = void 0;
|
|
16
|
+
exports.ConversationPbxAgentToJSON = exports.ConversationPbxAgentFromJSONTyped = exports.ConversationPbxAgentFromJSON = exports.instanceOfConversationPbxAgent = exports.ConversationPbxAgentUnavailableSayVoiceEnum = exports.ConversationPbxAgentStartupActivityEnum = exports.ConversationPbxAgentCallRoutingPreferenceEnum = void 0;
|
|
17
17
|
var runtime_1 = require("../runtime");
|
|
18
18
|
/**
|
|
19
19
|
* @export
|
|
@@ -23,6 +23,13 @@ exports.ConversationPbxAgentCallRoutingPreferenceEnum = {
|
|
|
23
23
|
HardwarePhone: 'hardware_phone',
|
|
24
24
|
Cellphone: 'cellphone'
|
|
25
25
|
};
|
|
26
|
+
/**
|
|
27
|
+
* @export
|
|
28
|
+
*/
|
|
29
|
+
exports.ConversationPbxAgentStartupActivityEnum = {
|
|
30
|
+
Available: 'available',
|
|
31
|
+
Unavailable: 'unavailable'
|
|
32
|
+
};
|
|
26
33
|
/**
|
|
27
34
|
* @export
|
|
28
35
|
*/
|
|
@@ -62,6 +69,7 @@ function ConversationPbxAgentFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
62
69
|
'preferred_hardware_phone_uuid': !(0, runtime_1.exists)(json, 'preferred_hardware_phone_uuid') ? undefined : json['preferred_hardware_phone_uuid'],
|
|
63
70
|
'record_outgoing_automatically': !(0, runtime_1.exists)(json, 'record_outgoing_automatically') ? undefined : json['record_outgoing_automatically'],
|
|
64
71
|
'shared_conversation_pbx_voicemail_mailbox_uuid': !(0, runtime_1.exists)(json, 'shared_conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['shared_conversation_pbx_voicemail_mailbox_uuid'],
|
|
72
|
+
'startup_activity': !(0, runtime_1.exists)(json, 'startup_activity') ? undefined : json['startup_activity'],
|
|
65
73
|
'twilio_taskrouter_worker_id': !(0, runtime_1.exists)(json, 'twilio_taskrouter_worker_id') ? undefined : json['twilio_taskrouter_worker_id'],
|
|
66
74
|
'unavailable_play_audio_uuid': !(0, runtime_1.exists)(json, 'unavailable_play_audio_uuid') ? undefined : json['unavailable_play_audio_uuid'],
|
|
67
75
|
'unavailable_say': !(0, runtime_1.exists)(json, 'unavailable_say') ? undefined : json['unavailable_say'],
|
|
@@ -96,6 +104,7 @@ function ConversationPbxAgentToJSON(value) {
|
|
|
96
104
|
'preferred_hardware_phone_uuid': value.preferred_hardware_phone_uuid,
|
|
97
105
|
'record_outgoing_automatically': value.record_outgoing_automatically,
|
|
98
106
|
'shared_conversation_pbx_voicemail_mailbox_uuid': value.shared_conversation_pbx_voicemail_mailbox_uuid,
|
|
107
|
+
'startup_activity': value.startup_activity,
|
|
99
108
|
'twilio_taskrouter_worker_id': value.twilio_taskrouter_worker_id,
|
|
100
109
|
'unavailable_play_audio_uuid': value.unavailable_play_audio_uuid,
|
|
101
110
|
'unavailable_say': value.unavailable_say,
|
package/package.json
CHANGED
package/src/apis/SfvbApi.ts
CHANGED
|
@@ -4765,7 +4765,7 @@ export interface SfvbApiInterface {
|
|
|
4765
4765
|
revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
|
|
4766
4766
|
|
|
4767
4767
|
/**
|
|
4768
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
4768
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
4769
4769
|
* @summary Request a content review of a flow or campaign email
|
|
4770
4770
|
* @param {number} storefrontOid
|
|
4771
4771
|
* @param {string} emailUuid
|
|
@@ -4777,7 +4777,7 @@ export interface SfvbApiInterface {
|
|
|
4777
4777
|
reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
4778
4778
|
|
|
4779
4779
|
/**
|
|
4780
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
4780
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
4781
4781
|
* Request a content review of a flow or campaign email
|
|
4782
4782
|
*/
|
|
4783
4783
|
reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
@@ -13942,7 +13942,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
13942
13942
|
}
|
|
13943
13943
|
|
|
13944
13944
|
/**
|
|
13945
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
13945
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
13946
13946
|
* Request a content review of a flow or campaign email
|
|
13947
13947
|
*/
|
|
13948
13948
|
async reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>> {
|
|
@@ -13985,7 +13985,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
13985
13985
|
}
|
|
13986
13986
|
|
|
13987
13987
|
/**
|
|
13988
|
-
* Starts a review the way the admin\'s Request Review does.
|
|
13988
|
+
* Starts a review the way the admin\'s Request Review does. The review runs in the background and no test copy is sent. The email is marked pending_review at once, and the signed-in user gets the approved or rejected notice, so read the email again for the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
|
|
13989
13989
|
* Request a content review of a flow or campaign email
|
|
13990
13990
|
*/
|
|
13991
13991
|
async reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail> {
|
|
@@ -69,7 +69,7 @@ export interface AutoOrderItem {
|
|
|
69
69
|
*/
|
|
70
70
|
arbitrary_percentage_discount?: number;
|
|
71
71
|
/**
|
|
72
|
-
*
|
|
72
|
+
* Quantity to rebill. When set, every rebill uses this quantity instead of original_quantity. Set this field to change the quantity on an active auto order; the merchant auto order editor updates this same field. Each rebill charges the unit price multiplied by this quantity.
|
|
73
73
|
* @type {number}
|
|
74
74
|
* @memberof AutoOrderItem
|
|
75
75
|
*/
|
|
@@ -81,7 +81,7 @@ export interface AutoOrderItem {
|
|
|
81
81
|
*/
|
|
82
82
|
arbitrary_schedule_days?: number;
|
|
83
83
|
/**
|
|
84
|
-
* Arbitrary unit cost that rebills of this item should occur at
|
|
84
|
+
* Arbitrary unit cost that rebills of this item should occur at. This is a price per unit. Each rebill charges it multiplied by the rebill quantity (arbitrary_quantity, or original_quantity when arbitrary_quantity is null).
|
|
85
85
|
* @type {number}
|
|
86
86
|
* @memberof AutoOrderItem
|
|
87
87
|
*/
|
|
@@ -189,7 +189,7 @@ export interface AutoOrderItem {
|
|
|
189
189
|
*/
|
|
190
190
|
original_item_id?: string;
|
|
191
191
|
/**
|
|
192
|
-
* The original quantity
|
|
192
|
+
* The quantity purchased on the original order. Rebills use this quantity only when arbitrary_quantity is null. To change the quantity on future rebills, set arbitrary_quantity instead.
|
|
193
193
|
* @type {number}
|
|
194
194
|
* @memberof AutoOrderItem
|
|
195
195
|
*/
|
|
@@ -110,6 +110,12 @@ export interface ConversationAgentAuth {
|
|
|
110
110
|
* @memberof ConversationAgentAuth
|
|
111
111
|
*/
|
|
112
112
|
pbx_jwt?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Status the agent starts in when the CRM loads
|
|
115
|
+
* @type {string}
|
|
116
|
+
* @memberof ConversationAgentAuth
|
|
117
|
+
*/
|
|
118
|
+
pbx_startup_activity?: ConversationAgentAuthPbxStartupActivityEnum;
|
|
113
119
|
/**
|
|
114
120
|
*
|
|
115
121
|
* @type {boolean}
|
|
@@ -168,6 +174,16 @@ export interface ConversationAgentAuth {
|
|
|
168
174
|
|
|
169
175
|
|
|
170
176
|
|
|
177
|
+
/**
|
|
178
|
+
* @export
|
|
179
|
+
*/
|
|
180
|
+
export const ConversationAgentAuthPbxStartupActivityEnum = {
|
|
181
|
+
Available: 'available',
|
|
182
|
+
Unavailable: 'unavailable'
|
|
183
|
+
} as const;
|
|
184
|
+
export type ConversationAgentAuthPbxStartupActivityEnum = typeof ConversationAgentAuthPbxStartupActivityEnum[keyof typeof ConversationAgentAuthPbxStartupActivityEnum];
|
|
185
|
+
|
|
186
|
+
|
|
171
187
|
/**
|
|
172
188
|
* Check if a given object implements the ConversationAgentAuth interface.
|
|
173
189
|
*/
|
|
@@ -200,6 +216,7 @@ export function ConversationAgentAuthFromJSONTyped(json: any, ignoreDiscriminato
|
|
|
200
216
|
'parent_merchant_id': !exists(json, 'parent_merchant_id') ? undefined : json['parent_merchant_id'],
|
|
201
217
|
'pbx_admin': !exists(json, 'pbx_admin') ? undefined : json['pbx_admin'],
|
|
202
218
|
'pbx_jwt': !exists(json, 'pbx_jwt') ? undefined : json['pbx_jwt'],
|
|
219
|
+
'pbx_startup_activity': !exists(json, 'pbx_startup_activity') ? undefined : json['pbx_startup_activity'],
|
|
203
220
|
'pbx_supervisor': !exists(json, 'pbx_supervisor') ? undefined : json['pbx_supervisor'],
|
|
204
221
|
'pbx_user': !exists(json, 'pbx_user') ? undefined : json['pbx_user'],
|
|
205
222
|
'pbx_voice_identity': !exists(json, 'pbx_voice_identity') ? undefined : json['pbx_voice_identity'],
|
|
@@ -234,6 +251,7 @@ export function ConversationAgentAuthToJSON(value?: ConversationAgentAuth | null
|
|
|
234
251
|
'parent_merchant_id': value.parent_merchant_id,
|
|
235
252
|
'pbx_admin': value.pbx_admin,
|
|
236
253
|
'pbx_jwt': value.pbx_jwt,
|
|
254
|
+
'pbx_startup_activity': value.pbx_startup_activity,
|
|
237
255
|
'pbx_supervisor': value.pbx_supervisor,
|
|
238
256
|
'pbx_user': value.pbx_user,
|
|
239
257
|
'pbx_voice_identity': value.pbx_voice_identity,
|
|
@@ -109,6 +109,12 @@ export interface ConversationPbxAgent {
|
|
|
109
109
|
* @memberof ConversationPbxAgent
|
|
110
110
|
*/
|
|
111
111
|
shared_conversation_pbx_voicemail_mailbox_uuid?: string;
|
|
112
|
+
/**
|
|
113
|
+
* Status the agent starts in when the CRM loads. Missing means available.
|
|
114
|
+
* @type {string}
|
|
115
|
+
* @memberof ConversationPbxAgent
|
|
116
|
+
*/
|
|
117
|
+
startup_activity?: ConversationPbxAgentStartupActivityEnum;
|
|
112
118
|
/**
|
|
113
119
|
* Twilio taskrouter worker Id
|
|
114
120
|
* @type {string}
|
|
@@ -171,6 +177,15 @@ export const ConversationPbxAgentCallRoutingPreferenceEnum = {
|
|
|
171
177
|
} as const;
|
|
172
178
|
export type ConversationPbxAgentCallRoutingPreferenceEnum = typeof ConversationPbxAgentCallRoutingPreferenceEnum[keyof typeof ConversationPbxAgentCallRoutingPreferenceEnum];
|
|
173
179
|
|
|
180
|
+
/**
|
|
181
|
+
* @export
|
|
182
|
+
*/
|
|
183
|
+
export const ConversationPbxAgentStartupActivityEnum = {
|
|
184
|
+
Available: 'available',
|
|
185
|
+
Unavailable: 'unavailable'
|
|
186
|
+
} as const;
|
|
187
|
+
export type ConversationPbxAgentStartupActivityEnum = typeof ConversationPbxAgentStartupActivityEnum[keyof typeof ConversationPbxAgentStartupActivityEnum];
|
|
188
|
+
|
|
174
189
|
/**
|
|
175
190
|
* @export
|
|
176
191
|
*/
|
|
@@ -215,6 +230,7 @@ export function ConversationPbxAgentFromJSONTyped(json: any, ignoreDiscriminator
|
|
|
215
230
|
'preferred_hardware_phone_uuid': !exists(json, 'preferred_hardware_phone_uuid') ? undefined : json['preferred_hardware_phone_uuid'],
|
|
216
231
|
'record_outgoing_automatically': !exists(json, 'record_outgoing_automatically') ? undefined : json['record_outgoing_automatically'],
|
|
217
232
|
'shared_conversation_pbx_voicemail_mailbox_uuid': !exists(json, 'shared_conversation_pbx_voicemail_mailbox_uuid') ? undefined : json['shared_conversation_pbx_voicemail_mailbox_uuid'],
|
|
233
|
+
'startup_activity': !exists(json, 'startup_activity') ? undefined : json['startup_activity'],
|
|
218
234
|
'twilio_taskrouter_worker_id': !exists(json, 'twilio_taskrouter_worker_id') ? undefined : json['twilio_taskrouter_worker_id'],
|
|
219
235
|
'unavailable_play_audio_uuid': !exists(json, 'unavailable_play_audio_uuid') ? undefined : json['unavailable_play_audio_uuid'],
|
|
220
236
|
'unavailable_say': !exists(json, 'unavailable_say') ? undefined : json['unavailable_say'],
|
|
@@ -250,6 +266,7 @@ export function ConversationPbxAgentToJSON(value?: ConversationPbxAgent | null):
|
|
|
250
266
|
'preferred_hardware_phone_uuid': value.preferred_hardware_phone_uuid,
|
|
251
267
|
'record_outgoing_automatically': value.record_outgoing_automatically,
|
|
252
268
|
'shared_conversation_pbx_voicemail_mailbox_uuid': value.shared_conversation_pbx_voicemail_mailbox_uuid,
|
|
269
|
+
'startup_activity': value.startup_activity,
|
|
253
270
|
'twilio_taskrouter_worker_id': value.twilio_taskrouter_worker_id,
|
|
254
271
|
'unavailable_play_audio_uuid': value.unavailable_play_audio_uuid,
|
|
255
272
|
'unavailable_say': value.unavailable_say,
|