@distilled.cloud/ovh 0.0.0 → 1.0.0-rc.9
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/LICENSE +201 -0
- package/lib/credentials.d.ts +38 -0
- package/lib/credentials.d.ts.map +1 -0
- package/lib/credentials.js +54 -0
- package/lib/credentials.js.map +1 -0
- package/lib/errors.d.ts +36 -0
- package/lib/errors.d.ts.map +1 -0
- package/lib/errors.js +26 -0
- package/lib/errors.js.map +1 -0
- package/lib/index.d.ts +22 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +22 -0
- package/lib/index.js.map +1 -0
- package/lib/pagination.d.ts +8 -0
- package/lib/pagination.d.ts.map +1 -0
- package/lib/pagination.js +8 -0
- package/lib/pagination.js.map +1 -0
- package/lib/protocol.d.ts +18 -0
- package/lib/protocol.d.ts.map +1 -0
- package/lib/protocol.js +60 -0
- package/lib/protocol.js.map +1 -0
- package/lib/retry.d.ts +32 -0
- package/lib/retry.d.ts.map +1 -0
- package/lib/retry.js +32 -0
- package/lib/retry.js.map +1 -0
- package/lib/services/baremetal.d.ts +3551 -0
- package/lib/services/baremetal.d.ts.map +1 -0
- package/lib/services/baremetal.js +4200 -0
- package/lib/services/baremetal.js.map +1 -0
- package/lib/services/cloud.d.ts +26011 -0
- package/lib/services/cloud.d.ts.map +1 -0
- package/lib/services/cloud.js +31119 -0
- package/lib/services/cloud.js.map +1 -0
- package/lib/services/cloud_v2.d.ts +5642 -0
- package/lib/services/cloud_v2.d.ts.map +1 -0
- package/lib/services/cloud_v2.js +5760 -0
- package/lib/services/cloud_v2.js.map +1 -0
- package/lib/services/dedicatedceph.d.ts +747 -0
- package/lib/services/dedicatedceph.d.ts.map +1 -0
- package/lib/services/dedicatedceph.js +962 -0
- package/lib/services/dedicatedceph.js.map +1 -0
- package/lib/services/dedicatednasha.d.ts +755 -0
- package/lib/services/dedicatednasha.d.ts.map +1 -0
- package/lib/services/dedicatednasha.js +967 -0
- package/lib/services/dedicatednasha.js.map +1 -0
- package/lib/services/domain.d.ts +2995 -0
- package/lib/services/domain.d.ts.map +1 -0
- package/lib/services/domain.js +3080 -0
- package/lib/services/domain.js.map +1 -0
- package/lib/services/emaildomain.d.ts +1913 -0
- package/lib/services/emaildomain.d.ts.map +1 -0
- package/lib/services/emaildomain.js +2550 -0
- package/lib/services/emaildomain.js.map +1 -0
- package/lib/services/emailmxplan.d.ts +1012 -0
- package/lib/services/emailmxplan.d.ts.map +1 -0
- package/lib/services/emailmxplan.js +1155 -0
- package/lib/services/emailmxplan.js.map +1 -0
- package/lib/services/emailpro.d.ts +1287 -0
- package/lib/services/emailpro.d.ts.map +1 -0
- package/lib/services/emailpro.js +1471 -0
- package/lib/services/emailpro.js.map +1 -0
- package/lib/services/hostingprivatedatabase.d.ts +1402 -0
- package/lib/services/hostingprivatedatabase.d.ts.map +1 -0
- package/lib/services/hostingprivatedatabase.js +1833 -0
- package/lib/services/hostingprivatedatabase.js.map +1 -0
- package/lib/services/iam.d.ts +829 -0
- package/lib/services/iam.d.ts.map +1 -0
- package/lib/services/iam.js +793 -0
- package/lib/services/iam.js.map +1 -0
- package/lib/services/index.d.ts +31 -0
- package/lib/services/index.d.ts.map +1 -0
- package/lib/services/index.js +32 -0
- package/lib/services/index.js.map +1 -0
- package/lib/services/ip.d.ts +1417 -0
- package/lib/services/ip.d.ts.map +1 -0
- package/lib/services/ip.js +1691 -0
- package/lib/services/ip.js.map +1 -0
- package/lib/services/iploadbalancing.d.ts +3059 -0
- package/lib/services/iploadbalancing.d.ts.map +1 -0
- package/lib/services/iploadbalancing.js +3554 -0
- package/lib/services/iploadbalancing.js.map +1 -0
- package/lib/services/ldp.d.ts +2492 -0
- package/lib/services/ldp.d.ts.map +1 -0
- package/lib/services/ldp.js +3072 -0
- package/lib/services/ldp.js.map +1 -0
- package/lib/services/me.d.ts +7511 -0
- package/lib/services/me.d.ts.map +1 -0
- package/lib/services/me.js +8878 -0
- package/lib/services/me.js.map +1 -0
- package/lib/services/overthebox.d.ts +981 -0
- package/lib/services/overthebox.d.ts.map +1 -0
- package/lib/services/overthebox.js +1122 -0
- package/lib/services/overthebox.js.map +1 -0
- package/lib/services/ovhcloudconnect.d.ts +1123 -0
- package/lib/services/ovhcloudconnect.d.ts.map +1 -0
- package/lib/services/ovhcloudconnect.js +1353 -0
- package/lib/services/ovhcloudconnect.js.map +1 -0
- package/lib/services/packxdsl.d.ts +1583 -0
- package/lib/services/packxdsl.d.ts.map +1 -0
- package/lib/services/packxdsl.js +1791 -0
- package/lib/services/packxdsl.js.map +1 -0
- package/lib/services/sms.d.ts +2602 -0
- package/lib/services/sms.d.ts.map +1 -0
- package/lib/services/sms.js +2995 -0
- package/lib/services/sms.js.map +1 -0
- package/lib/services/sslgateway.d.ts +493 -0
- package/lib/services/sslgateway.d.ts.map +1 -0
- package/lib/services/sslgateway.js +569 -0
- package/lib/services/sslgateway.js.map +1 -0
- package/lib/services/storagenetapp.d.ts +859 -0
- package/lib/services/storagenetapp.d.ts.map +1 -0
- package/lib/services/storagenetapp.js +1022 -0
- package/lib/services/storagenetapp.js.map +1 -0
- package/lib/services/support.d.ts +233 -0
- package/lib/services/support.d.ts.map +1 -0
- package/lib/services/support.js +237 -0
- package/lib/services/support.js.map +1 -0
- package/lib/services/telephony.d.ts +10825 -0
- package/lib/services/telephony.d.ts.map +1 -0
- package/lib/services/telephony.js +14894 -0
- package/lib/services/telephony.js.map +1 -0
- package/lib/services/vmwareclouddirectorbackup.d.ts +784 -0
- package/lib/services/vmwareclouddirectorbackup.d.ts.map +1 -0
- package/lib/services/vmwareclouddirectorbackup.js +842 -0
- package/lib/services/vmwareclouddirectorbackup.js.map +1 -0
- package/lib/services/vmwareclouddirectororganization.d.ts +784 -0
- package/lib/services/vmwareclouddirectororganization.d.ts.map +1 -0
- package/lib/services/vmwareclouddirectororganization.js +842 -0
- package/lib/services/vmwareclouddirectororganization.js.map +1 -0
- package/lib/services/vps.d.ts +1579 -0
- package/lib/services/vps.d.ts.map +1 -0
- package/lib/services/vps.js +1914 -0
- package/lib/services/vps.js.map +1 -0
- package/lib/services/vrack.d.ts +1204 -0
- package/lib/services/vrack.d.ts.map +1 -0
- package/lib/services/vrack.js +1627 -0
- package/lib/services/vrack.js.map +1 -0
- package/lib/services/vrackservices.d.ts +394 -0
- package/lib/services/vrackservices.d.ts.map +1 -0
- package/lib/services/vrackservices.js +355 -0
- package/lib/services/vrackservices.js.map +1 -0
- package/lib/services/webhosting.d.ts +3986 -0
- package/lib/services/webhosting.d.ts.map +1 -0
- package/lib/services/webhosting.js +4527 -0
- package/lib/services/webhosting.js.map +1 -0
- package/lib/services/xdsl.d.ts +3433 -0
- package/lib/services/xdsl.d.ts.map +1 -0
- package/lib/services/xdsl.js +3682 -0
- package/lib/services/xdsl.js.map +1 -0
- package/lib/traits.d.ts +11 -0
- package/lib/traits.d.ts.map +1 -0
- package/lib/traits.js +11 -0
- package/lib/traits.js.map +1 -0
- package/package.json +77 -6
- package/src/credentials.ts +77 -0
- package/src/errors.ts +50 -0
- package/src/index.ts +21 -0
- package/src/pagination.ts +7 -0
- package/src/protocol.ts +86 -0
- package/src/retry.ts +54 -0
- package/src/services/baremetal.ts +10954 -0
- package/src/services/cloud.ts +75508 -0
- package/src/services/cloud_v2.ts +14751 -0
- package/src/services/dedicatedceph.ts +2233 -0
- package/src/services/dedicatednasha.ts +2269 -0
- package/src/services/domain.ts +7998 -0
- package/src/services/emaildomain.ts +5751 -0
- package/src/services/emailmxplan.ts +2764 -0
- package/src/services/emailpro.ts +3519 -0
- package/src/services/hostingprivatedatabase.ts +4218 -0
- package/src/services/iam.ts +2060 -0
- package/src/services/index.ts +31 -0
- package/src/services/ip.ts +4462 -0
- package/src/services/iploadbalancing.ts +8422 -0
- package/src/services/ldp.ts +7274 -0
- package/src/services/me.ts +21720 -0
- package/src/services/overthebox.ts +2693 -0
- package/src/services/ovhcloudconnect.ts +3226 -0
- package/src/services/packxdsl.ts +4623 -0
- package/src/services/sms.ts +7255 -0
- package/src/services/sslgateway.ts +1408 -0
- package/src/services/storagenetapp.ts +2433 -0
- package/src/services/support.ts +598 -0
- package/src/services/telephony.ts +32941 -0
- package/src/services/vmwareclouddirectorbackup.ts +2171 -0
- package/src/services/vmwareclouddirectororganization.ts +2171 -0
- package/src/services/vps.ts +5134 -0
- package/src/services/vrack.ts +3730 -0
- package/src/services/vrackservices.ts +939 -0
- package/src/services/webhosting.ts +11290 -0
- package/src/services/xdsl.ts +9278 -0
- package/src/traits.ts +44 -0
|
@@ -0,0 +1,2602 @@
|
|
|
1
|
+
import * as S from "@distilled.cloud/core/schema";
|
|
2
|
+
import * as Redacted from "effect/Redacted";
|
|
3
|
+
import * as API from "@distilled.cloud/core/api";
|
|
4
|
+
import { type OvhOpError, type OvhOpContext } from "../protocol.ts";
|
|
5
|
+
export type { OvhOpError, OvhOpContext };
|
|
6
|
+
export interface CancelSmsBatchRequest {
|
|
7
|
+
/** The internal name of your SMS offer */
|
|
8
|
+
serviceName: string;
|
|
9
|
+
/** Id */
|
|
10
|
+
id: string;
|
|
11
|
+
}
|
|
12
|
+
export declare const CancelSmsBatchRequest: S.Schema<CancelSmsBatchRequest>;
|
|
13
|
+
/** Batch error details */
|
|
14
|
+
export interface SmsBatchError {
|
|
15
|
+
/** Error message */
|
|
16
|
+
message?: string;
|
|
17
|
+
/** Receiver that triggered the error */
|
|
18
|
+
receiver?: string;
|
|
19
|
+
}
|
|
20
|
+
export declare const SmsBatchError: S.Schema<SmsBatchError>;
|
|
21
|
+
/** Details on error(s) on the batch, if any */
|
|
22
|
+
export type SmsBatchErrorsList = Array<SmsBatchError>;
|
|
23
|
+
export declare const SmsBatchErrorsList: S.Schema<SmsBatchErrorsList>;
|
|
24
|
+
/** SMS receivers list */
|
|
25
|
+
export type SmsBatchReceiversList = Array<string>;
|
|
26
|
+
export declare const SmsBatchReceiversList: S.Schema<SmsBatchReceiversList>;
|
|
27
|
+
/** Batch statuses */
|
|
28
|
+
export type SmsBatchStatusEnum = "CANCELED" | "CANCELING" | "COMPLETED" | "FAILED" | "INSERTED" | "INSERTING" | "PENDING" | "TO_CANCEL";
|
|
29
|
+
export declare const SmsBatchStatusEnum: any;
|
|
30
|
+
/** Batch of SMS to send */
|
|
31
|
+
export interface SmsBatch {
|
|
32
|
+
/** SMS account ID */
|
|
33
|
+
accountID?: number;
|
|
34
|
+
/** Creation datetime */
|
|
35
|
+
createdAt?: string;
|
|
36
|
+
/** Details on error(s) on the batch, if any */
|
|
37
|
+
errors?: SmsBatchErrorsList;
|
|
38
|
+
/** The estimated cost of the batch in credits */
|
|
39
|
+
estimatedCredits?: number;
|
|
40
|
+
/** Datetime when the batch finished processing SMSs */
|
|
41
|
+
finishedAt?: string | null;
|
|
42
|
+
/** SMS sender */
|
|
43
|
+
from?: string | null;
|
|
44
|
+
/** Batch ID */
|
|
45
|
+
id?: string;
|
|
46
|
+
/** SMS message */
|
|
47
|
+
message?: string;
|
|
48
|
+
/** Batch name */
|
|
49
|
+
name?: string;
|
|
50
|
+
/** Number of processed records in this batch */
|
|
51
|
+
processedRecords?: number;
|
|
52
|
+
/** SMS receivers list */
|
|
53
|
+
receivers?: SmsBatchReceiversList | null;
|
|
54
|
+
/** Datetime when the SMSs of the batch are sent (based on deferred time if exists) */
|
|
55
|
+
sentAt?: string | null;
|
|
56
|
+
/** Slot ID */
|
|
57
|
+
slotID?: string | null;
|
|
58
|
+
/** Datetime when the batch started processing SMSs */
|
|
59
|
+
startedAt?: string | null;
|
|
60
|
+
/** Batch status */
|
|
61
|
+
status?: SmsBatchStatusEnum;
|
|
62
|
+
/** Total number of records in this batch */
|
|
63
|
+
totalRecords?: number;
|
|
64
|
+
/** Last update datetime */
|
|
65
|
+
updatedAt?: string;
|
|
66
|
+
}
|
|
67
|
+
export declare const SmsBatch: S.Schema<SmsBatch>;
|
|
68
|
+
/** SMS classes */
|
|
69
|
+
export type SmsBatchClassEnum = "FLASH" | "PHONE" | "SIM";
|
|
70
|
+
export declare const SmsBatchClassEnum: any;
|
|
71
|
+
/** SMS receivers list. Either "to" or "slotID" must be passed */
|
|
72
|
+
export type CreateSmsBatchRequestToList = Array<string>;
|
|
73
|
+
export declare const CreateSmsBatchRequestToList: S.Schema<CreateSmsBatchRequestToList>;
|
|
74
|
+
export interface CreateSmsBatchRequest {
|
|
75
|
+
/** The internal name of your SMS offer */
|
|
76
|
+
serviceName: string;
|
|
77
|
+
/** Deprecated: SMS class */
|
|
78
|
+
class?: SmsBatchClassEnum | (string & {});
|
|
79
|
+
/** SMS deferred sending date */
|
|
80
|
+
deferred?: string;
|
|
81
|
+
/** SMS sender. Either "from" or "senderForResponse" must be passed */
|
|
82
|
+
from?: string;
|
|
83
|
+
/** SMS message */
|
|
84
|
+
message: string;
|
|
85
|
+
/** Batch name */
|
|
86
|
+
name?: string;
|
|
87
|
+
/** STOP clause not needed */
|
|
88
|
+
noStop?: boolean;
|
|
89
|
+
/** Ask to compute a sender that allows response. Either "from" or "senderForResponse" must be passed */
|
|
90
|
+
senderForResponse?: boolean;
|
|
91
|
+
/** SMS receivers slot ID. Either "to" or "slotID" must be passed */
|
|
92
|
+
slotID?: string;
|
|
93
|
+
/** SMS tag */
|
|
94
|
+
tag?: string;
|
|
95
|
+
/** SMS receivers list. Either "to" or "slotID" must be passed */
|
|
96
|
+
to?: CreateSmsBatchRequestToList;
|
|
97
|
+
}
|
|
98
|
+
export declare const CreateSmsBatchRequest: S.Schema<CreateSmsBatchRequest>;
|
|
99
|
+
/** All existing types for a given sender */
|
|
100
|
+
export type SmsTypeSenderEnum = "alpha" | "numeric" | "shortcode" | "virtual";
|
|
101
|
+
export declare const SmsTypeSenderEnum: any;
|
|
102
|
+
export interface CreateSmsEstimateRequest {
|
|
103
|
+
/** The message to send */
|
|
104
|
+
message: string;
|
|
105
|
+
/** Do not display STOP clause in the message, this requires that this is not an advertising message */
|
|
106
|
+
noStopClause: boolean;
|
|
107
|
+
/** Sender type that will be used to send the message */
|
|
108
|
+
senderType: SmsTypeSenderEnum | (string & {});
|
|
109
|
+
}
|
|
110
|
+
export declare const CreateSmsEstimateRequest: S.Schema<CreateSmsEstimateRequest>;
|
|
111
|
+
/** The SMS available characters class */
|
|
112
|
+
export type SmsEncodingEnum = "7bits" | "unicode";
|
|
113
|
+
export declare const SmsEncodingEnum: any;
|
|
114
|
+
/** A structure describing the encoding, length and number of SMS parts of a text message */
|
|
115
|
+
export interface SmsJobEstimate {
|
|
116
|
+
/** The number of characters the message contains, including invisible escaped characters */
|
|
117
|
+
characters?: number;
|
|
118
|
+
/** The characters class that will be used to send the SMS, depending on characters in message */
|
|
119
|
+
charactersClass?: SmsEncodingEnum;
|
|
120
|
+
/** The number of characters every SMS part can contain, depending on characters class and quantity of parts */
|
|
121
|
+
maxCharactersPerPart?: number;
|
|
122
|
+
/** The quantity of SMS parts the message will be split in */
|
|
123
|
+
parts?: number;
|
|
124
|
+
}
|
|
125
|
+
export declare const SmsJobEstimate: S.Schema<SmsJobEstimate>;
|
|
126
|
+
/** The receivers */
|
|
127
|
+
export type CreateSmsHlrRequestReceiversList = Array<string>;
|
|
128
|
+
export declare const CreateSmsHlrRequestReceiversList: S.Schema<CreateSmsHlrRequestReceiversList>;
|
|
129
|
+
export interface CreateSmsHlrRequest {
|
|
130
|
+
/** The internal name of your SMS offer */
|
|
131
|
+
serviceName: string;
|
|
132
|
+
/** The receivers */
|
|
133
|
+
receivers?: CreateSmsHlrRequestReceiversList;
|
|
134
|
+
/** The receivers document url link in csv format */
|
|
135
|
+
receiversDocumentUrl?: string;
|
|
136
|
+
}
|
|
137
|
+
export declare const CreateSmsHlrRequest: S.Schema<CreateSmsHlrRequest>;
|
|
138
|
+
export type SmsSmsSendingReportIdsList = Array<number>;
|
|
139
|
+
export declare const SmsSmsSendingReportIdsList: S.Schema<SmsSmsSendingReportIdsList>;
|
|
140
|
+
export type SmsSmsSendingReportInvalidReceiversList = Array<string>;
|
|
141
|
+
export declare const SmsSmsSendingReportInvalidReceiversList: S.Schema<SmsSmsSendingReportInvalidReceiversList>;
|
|
142
|
+
export type SmsSmsSendingReportValidReceiversList = Array<string>;
|
|
143
|
+
export declare const SmsSmsSendingReportValidReceiversList: S.Schema<SmsSmsSendingReportValidReceiversList>;
|
|
144
|
+
/** A structure describing all information about quota informations */
|
|
145
|
+
export interface SmsSmsSendingReport {
|
|
146
|
+
ids?: SmsSmsSendingReportIdsList;
|
|
147
|
+
invalidReceivers?: SmsSmsSendingReportInvalidReceiversList;
|
|
148
|
+
tag?: string;
|
|
149
|
+
totalCreditsRemoved?: number;
|
|
150
|
+
validReceivers?: SmsSmsSendingReportValidReceiversList;
|
|
151
|
+
}
|
|
152
|
+
export declare const SmsSmsSendingReport: S.Schema<SmsSmsSendingReport>;
|
|
153
|
+
/** The charset format */
|
|
154
|
+
export type SmsCharsetEnum = "UTF-8";
|
|
155
|
+
export declare const SmsCharsetEnum: any;
|
|
156
|
+
/** Deprecated: The sms class of sms sending job */
|
|
157
|
+
export type SmsClassEnum = "flash" | "phoneDisplay" | "sim" | "toolkit";
|
|
158
|
+
export declare const SmsClassEnum: any;
|
|
159
|
+
/** The sms coding */
|
|
160
|
+
export type SmsCodingEnum = "7bit" | "8bit";
|
|
161
|
+
export declare const SmsCodingEnum: any;
|
|
162
|
+
/** The priority of an sms sending */
|
|
163
|
+
export type SmsPriorityEnum = "high" | "low" | "medium" | "veryLow";
|
|
164
|
+
export declare const SmsPriorityEnum: any;
|
|
165
|
+
/** The receivers list */
|
|
166
|
+
export type CreateSmsJobRequestReceiversList = Array<string>;
|
|
167
|
+
export declare const CreateSmsJobRequestReceiversList: S.Schema<CreateSmsJobRequestReceiversList>;
|
|
168
|
+
export interface CreateSmsJobRequest {
|
|
169
|
+
/** The internal name of your SMS offer */
|
|
170
|
+
serviceName: string;
|
|
171
|
+
/** The sms coding */
|
|
172
|
+
charset?: SmsCharsetEnum | (string & {});
|
|
173
|
+
/** Deprecated: The sms class */
|
|
174
|
+
class?: SmsClassEnum | (string & {});
|
|
175
|
+
/** Deprecated: the coding is deduced from the message and its charset */
|
|
176
|
+
coding?: SmsCodingEnum | (string & {});
|
|
177
|
+
/** The time -in minute(s)- to wait before sending the message */
|
|
178
|
+
differedPeriod?: number;
|
|
179
|
+
/** The sms message */
|
|
180
|
+
message: string;
|
|
181
|
+
/** Do not display STOP clause in the message, this requires that this is not an advertising message */
|
|
182
|
+
noStopClause?: boolean;
|
|
183
|
+
/** The priority of the message */
|
|
184
|
+
priority?: SmsPriorityEnum | (string & {});
|
|
185
|
+
/** The receivers list */
|
|
186
|
+
receivers?: CreateSmsJobRequestReceiversList;
|
|
187
|
+
/** The receivers document url link in csv format */
|
|
188
|
+
receiversDocumentUrl?: string;
|
|
189
|
+
/** The receivers document slot id */
|
|
190
|
+
receiversSlotId?: string;
|
|
191
|
+
/** The sender */
|
|
192
|
+
sender?: string;
|
|
193
|
+
/** Set the flag to send a special sms which can be reply by the receiver (smsResponse). */
|
|
194
|
+
senderForResponse?: boolean;
|
|
195
|
+
/** The identifier group tag */
|
|
196
|
+
tag?: string;
|
|
197
|
+
/** The maximum time -in minute(s)- before the message is dropped */
|
|
198
|
+
validityPeriod?: number;
|
|
199
|
+
}
|
|
200
|
+
export declare const CreateSmsJobRequest: S.Schema<CreateSmsJobRequest>;
|
|
201
|
+
export interface CreateSmsPhonebookRequest {
|
|
202
|
+
/** The internal name of your SMS offer */
|
|
203
|
+
serviceName: string;
|
|
204
|
+
/** Name of the wanted phonebook */
|
|
205
|
+
name: string;
|
|
206
|
+
}
|
|
207
|
+
export declare const CreateSmsPhonebookRequest: S.Schema<CreateSmsPhonebookRequest>;
|
|
208
|
+
export type CreateSmsPhonebookResponse = string;
|
|
209
|
+
export declare const CreateSmsPhonebookResponse: S.Schema<CreateSmsPhonebookResponse>;
|
|
210
|
+
export interface CreateSmsPhonebookPhonebookContactRequest {
|
|
211
|
+
/** The internal name of your SMS offer */
|
|
212
|
+
serviceName: string;
|
|
213
|
+
/** Identifier of the phonebook */
|
|
214
|
+
bookKey: string;
|
|
215
|
+
/** Group name of the phonebook */
|
|
216
|
+
group: string;
|
|
217
|
+
/** Home mobile phone number of the contact */
|
|
218
|
+
homeMobile?: string;
|
|
219
|
+
/** Home landline phone number of the contact */
|
|
220
|
+
homePhone?: string;
|
|
221
|
+
/** Name of the contact */
|
|
222
|
+
name: string;
|
|
223
|
+
/** Contact surname */
|
|
224
|
+
surname: string;
|
|
225
|
+
/** Mobile phone office number of the contact */
|
|
226
|
+
workMobile?: string;
|
|
227
|
+
/** Landline phone office number of the contact */
|
|
228
|
+
workPhone?: string;
|
|
229
|
+
}
|
|
230
|
+
export declare const CreateSmsPhonebookPhonebookContactRequest: S.Schema<CreateSmsPhonebookPhonebookContactRequest>;
|
|
231
|
+
export type CreateSmsPhonebookPhonebookContactResponse = number;
|
|
232
|
+
export declare const CreateSmsPhonebookPhonebookContactResponse: S.Schema<CreateSmsPhonebookPhonebookContactResponse>;
|
|
233
|
+
export interface CreateSmsReceiverRequest {
|
|
234
|
+
/** The internal name of your SMS offer */
|
|
235
|
+
serviceName: string;
|
|
236
|
+
/** Download file from URL before sending to contacts (works only with csvUrl and not document ID) */
|
|
237
|
+
autoUpdate: boolean;
|
|
238
|
+
/** URL of the file you want to import */
|
|
239
|
+
csvUrl?: string;
|
|
240
|
+
/** Description name of the document */
|
|
241
|
+
description: string;
|
|
242
|
+
/** ID of the /me/document file you want to import */
|
|
243
|
+
documentId?: string;
|
|
244
|
+
/** Slot number id used to handle the document */
|
|
245
|
+
slotId: number;
|
|
246
|
+
}
|
|
247
|
+
export declare const CreateSmsReceiverRequest: S.Schema<CreateSmsReceiverRequest>;
|
|
248
|
+
/** Sms receivers preloaded */
|
|
249
|
+
export interface SmsReceiver {
|
|
250
|
+
/** Download file from URL before sending to contacts (works only with csvUrl and not document ID) */
|
|
251
|
+
autoUpdate?: boolean;
|
|
252
|
+
/** Is the object compatible with autoUpdate */
|
|
253
|
+
canAutoUpdate?: boolean;
|
|
254
|
+
/** Creation date of the document */
|
|
255
|
+
datetime?: string;
|
|
256
|
+
/** Description name of the document */
|
|
257
|
+
description?: string;
|
|
258
|
+
/** Number of receiver records in the document */
|
|
259
|
+
records?: number;
|
|
260
|
+
/** Slot number id */
|
|
261
|
+
slotId?: number;
|
|
262
|
+
}
|
|
263
|
+
export declare const SmsReceiver: S.Schema<SmsReceiver>;
|
|
264
|
+
export interface CreateSmsReceiverCleanRequest {
|
|
265
|
+
/** The internal name of your SMS offer */
|
|
266
|
+
serviceName: string;
|
|
267
|
+
/** Slot number id */
|
|
268
|
+
slotId: number;
|
|
269
|
+
/** Limit checks to syntaxical validation */
|
|
270
|
+
freemium: boolean;
|
|
271
|
+
/** Only get action's price in credits without executing it */
|
|
272
|
+
priceOnly: boolean;
|
|
273
|
+
}
|
|
274
|
+
export declare const CreateSmsReceiverCleanRequest: S.Schema<CreateSmsReceiverCleanRequest>;
|
|
275
|
+
/** A structure giving operation price and asynchronous task ID */
|
|
276
|
+
export interface SmsReceiversAsynchronousCleanReport {
|
|
277
|
+
taskId?: number;
|
|
278
|
+
totalCreditsRemoved?: number;
|
|
279
|
+
}
|
|
280
|
+
export declare const SmsReceiversAsynchronousCleanReport: S.Schema<SmsReceiversAsynchronousCleanReport>;
|
|
281
|
+
export interface CreateSmsSenderRequest {
|
|
282
|
+
/** The internal name of your SMS offer */
|
|
283
|
+
serviceName: string;
|
|
284
|
+
/** Sender description */
|
|
285
|
+
description?: string;
|
|
286
|
+
/** Message seen by the moderator */
|
|
287
|
+
reason?: string;
|
|
288
|
+
/** The sender (alpha or phone number) */
|
|
289
|
+
sender: string;
|
|
290
|
+
}
|
|
291
|
+
export declare const CreateSmsSenderRequest: S.Schema<CreateSmsSenderRequest>;
|
|
292
|
+
export type CreateSmsSenderResponse = string;
|
|
293
|
+
export declare const CreateSmsSenderResponse: S.Schema<CreateSmsSenderResponse>;
|
|
294
|
+
export interface CreateSmsSenderDocumentRequest {
|
|
295
|
+
/** The internal name of your SMS offer */
|
|
296
|
+
serviceName: string;
|
|
297
|
+
/** The sms sender */
|
|
298
|
+
sender: string;
|
|
299
|
+
/** Document description */
|
|
300
|
+
description?: string;
|
|
301
|
+
/** Document name */
|
|
302
|
+
name: string;
|
|
303
|
+
}
|
|
304
|
+
export declare const CreateSmsSenderDocumentRequest: S.Schema<CreateSmsSenderDocumentRequest>;
|
|
305
|
+
/** SMS senders' document */
|
|
306
|
+
export interface SmsSenderDocument {
|
|
307
|
+
/** Creation datetime */
|
|
308
|
+
createdAt?: string;
|
|
309
|
+
/** Document description */
|
|
310
|
+
description?: string | null;
|
|
311
|
+
/** Document ID */
|
|
312
|
+
documentID?: string;
|
|
313
|
+
/** URL to get document */
|
|
314
|
+
getUrl?: string;
|
|
315
|
+
/** Document name */
|
|
316
|
+
name?: string;
|
|
317
|
+
/** URL to upload document */
|
|
318
|
+
putUrl?: string | null;
|
|
319
|
+
/** Document size (in bytes) */
|
|
320
|
+
size?: number;
|
|
321
|
+
}
|
|
322
|
+
export declare const SmsSenderDocument: S.Schema<SmsSenderDocument>;
|
|
323
|
+
export interface CreateSmsSmppPasswordRequest {
|
|
324
|
+
/** The internal name of your SMS offer */
|
|
325
|
+
serviceName: string;
|
|
326
|
+
}
|
|
327
|
+
export declare const CreateSmsSmppPasswordRequest: S.Schema<CreateSmsSmppPasswordRequest>;
|
|
328
|
+
export interface CreateSmsSmppPasswordResponse {
|
|
329
|
+
}
|
|
330
|
+
export declare const CreateSmsSmppPasswordResponse: S.Schema<CreateSmsSmppPasswordResponse>;
|
|
331
|
+
/** All existing types for a given template */
|
|
332
|
+
export type SmsTypeTemplateEnum = "alerting" | "authentification" | "transactional";
|
|
333
|
+
export declare const SmsTypeTemplateEnum: any;
|
|
334
|
+
export interface CreateSmsTemplatesControlRequest {
|
|
335
|
+
/** The internal name of your SMS offer */
|
|
336
|
+
serviceName: string;
|
|
337
|
+
/** Specify the kind of template */
|
|
338
|
+
activity: SmsTypeTemplateEnum | (string & {});
|
|
339
|
+
/** Template description */
|
|
340
|
+
description?: string;
|
|
341
|
+
/** Message pattern to be moderated. Use "#VALUE#" format for dynamic text area. */
|
|
342
|
+
message: string;
|
|
343
|
+
/** Name of the template */
|
|
344
|
+
name: string;
|
|
345
|
+
/** Message seen by the moderator */
|
|
346
|
+
reason?: string;
|
|
347
|
+
}
|
|
348
|
+
export declare const CreateSmsTemplatesControlRequest: S.Schema<CreateSmsTemplatesControlRequest>;
|
|
349
|
+
export interface CreateSmsTemplatesControlResponse {
|
|
350
|
+
}
|
|
351
|
+
export declare const CreateSmsTemplatesControlResponse: S.Schema<CreateSmsTemplatesControlResponse>;
|
|
352
|
+
export interface CreateSmsTemplatesControlRelaunchValidationRequest {
|
|
353
|
+
/** The internal name of your SMS offer */
|
|
354
|
+
serviceName: string;
|
|
355
|
+
/** Name of the template */
|
|
356
|
+
name: string;
|
|
357
|
+
/** Template description */
|
|
358
|
+
description: string;
|
|
359
|
+
/** Message pattern to be moderated. Use "#VALUE#" format for dynamic text area */
|
|
360
|
+
message: string;
|
|
361
|
+
}
|
|
362
|
+
export declare const CreateSmsTemplatesControlRelaunchValidationRequest: S.Schema<CreateSmsTemplatesControlRelaunchValidationRequest>;
|
|
363
|
+
export interface CreateSmsTemplatesControlRelaunchValidationResponse {
|
|
364
|
+
}
|
|
365
|
+
export declare const CreateSmsTemplatesControlRelaunchValidationResponse: S.Schema<CreateSmsTemplatesControlRelaunchValidationResponse>;
|
|
366
|
+
export interface CreateSmsUserRequest {
|
|
367
|
+
/** The internal name of your SMS offer */
|
|
368
|
+
serviceName: string;
|
|
369
|
+
/** The sms login */
|
|
370
|
+
login: string;
|
|
371
|
+
/** The sms password */
|
|
372
|
+
password: string | Redacted.Redacted<string>;
|
|
373
|
+
}
|
|
374
|
+
export declare const CreateSmsUserRequest: S.Schema<CreateSmsUserRequest>;
|
|
375
|
+
export interface CreateSmsUserResponse {
|
|
376
|
+
}
|
|
377
|
+
export declare const CreateSmsUserResponse: S.Schema<CreateSmsUserResponse>;
|
|
378
|
+
/** The receivers list */
|
|
379
|
+
export type CreateSmsUserJobRequestReceiversList = Array<string>;
|
|
380
|
+
export declare const CreateSmsUserJobRequestReceiversList: S.Schema<CreateSmsUserJobRequestReceiversList>;
|
|
381
|
+
export interface CreateSmsUserJobRequest {
|
|
382
|
+
/** The internal name of your SMS offer */
|
|
383
|
+
serviceName: string;
|
|
384
|
+
/** The sms user login */
|
|
385
|
+
login: string;
|
|
386
|
+
/** The sms coding */
|
|
387
|
+
charset?: SmsCharsetEnum | (string & {});
|
|
388
|
+
/** Deprecated: The sms class */
|
|
389
|
+
class?: SmsClassEnum | (string & {});
|
|
390
|
+
/** Deprecated: the coding is deduced from the message and its charset */
|
|
391
|
+
coding?: SmsCodingEnum | (string & {});
|
|
392
|
+
/** The time -in minute(s)- to wait before sending the message */
|
|
393
|
+
differedPeriod?: number;
|
|
394
|
+
/** The sms message */
|
|
395
|
+
message: string;
|
|
396
|
+
/** Do not display STOP clause in the message, this requires that this is not an advertising message */
|
|
397
|
+
noStopClause?: boolean;
|
|
398
|
+
/** The priority of the message */
|
|
399
|
+
priority?: SmsPriorityEnum | (string & {});
|
|
400
|
+
/** The receivers list */
|
|
401
|
+
receivers?: CreateSmsUserJobRequestReceiversList;
|
|
402
|
+
/** The receivers document url link in csv format */
|
|
403
|
+
receiversDocumentUrl?: string;
|
|
404
|
+
/** The receivers document slot id */
|
|
405
|
+
receiversSlotId?: string;
|
|
406
|
+
/** The sender */
|
|
407
|
+
sender?: string;
|
|
408
|
+
/** Set the flag to send a special sms which can be reply by the receiver (smsResponse). */
|
|
409
|
+
senderForResponse?: boolean;
|
|
410
|
+
/** The identifier group tag */
|
|
411
|
+
tag?: string;
|
|
412
|
+
/** The maximum time -in minute(s)- before the message is dropped */
|
|
413
|
+
validityPeriod?: number;
|
|
414
|
+
}
|
|
415
|
+
export declare const CreateSmsUserJobRequest: S.Schema<CreateSmsUserJobRequest>;
|
|
416
|
+
export interface CreateSmsUserReceiverRequest {
|
|
417
|
+
/** The internal name of your SMS offer */
|
|
418
|
+
serviceName: string;
|
|
419
|
+
/** The sms user login */
|
|
420
|
+
login: string;
|
|
421
|
+
/** Download file from URL before sending to contacts (works only with csvUrl and not document ID) */
|
|
422
|
+
autoUpdate: boolean;
|
|
423
|
+
/** URL of the file you want to import */
|
|
424
|
+
csvUrl?: string;
|
|
425
|
+
/** Description name of the document */
|
|
426
|
+
description: string;
|
|
427
|
+
/** ID of the /me/document file you want to import */
|
|
428
|
+
documentId?: string;
|
|
429
|
+
/** Slot number id used to handle the document */
|
|
430
|
+
slotId: number;
|
|
431
|
+
}
|
|
432
|
+
export declare const CreateSmsUserReceiverRequest: S.Schema<CreateSmsUserReceiverRequest>;
|
|
433
|
+
export interface CreateSmsUserReceiverCleanRequest {
|
|
434
|
+
/** The internal name of your SMS offer */
|
|
435
|
+
serviceName: string;
|
|
436
|
+
/** The sms user login */
|
|
437
|
+
login: string;
|
|
438
|
+
/** Slot number id */
|
|
439
|
+
slotId: number;
|
|
440
|
+
/** Limit checks to syntaxical validation */
|
|
441
|
+
freemium: boolean;
|
|
442
|
+
/** Only get action's price in credits without executing it */
|
|
443
|
+
priceOnly: boolean;
|
|
444
|
+
}
|
|
445
|
+
export declare const CreateSmsUserReceiverCleanRequest: S.Schema<CreateSmsUserReceiverCleanRequest>;
|
|
446
|
+
export interface CreateSmsVirtualNumberChatAccessRequest {
|
|
447
|
+
/** The internal name of your SMS offer */
|
|
448
|
+
serviceName: string;
|
|
449
|
+
/** The virtual number */
|
|
450
|
+
number: string;
|
|
451
|
+
}
|
|
452
|
+
export declare const CreateSmsVirtualNumberChatAccessRequest: S.Schema<CreateSmsVirtualNumberChatAccessRequest>;
|
|
453
|
+
/** The web access for your virtual number chat application */
|
|
454
|
+
export interface SmsChatAccess {
|
|
455
|
+
/** The creation date of this access */
|
|
456
|
+
creationDate?: string;
|
|
457
|
+
id?: number;
|
|
458
|
+
/** The url of the web access */
|
|
459
|
+
url?: string;
|
|
460
|
+
}
|
|
461
|
+
export declare const SmsChatAccess: S.Schema<SmsChatAccess>;
|
|
462
|
+
/** The receivers list */
|
|
463
|
+
export type CreateSmsVirtualNumberJobRequestReceiversList = Array<string>;
|
|
464
|
+
export declare const CreateSmsVirtualNumberJobRequestReceiversList: S.Schema<CreateSmsVirtualNumberJobRequestReceiversList>;
|
|
465
|
+
export interface CreateSmsVirtualNumberJobRequest {
|
|
466
|
+
/** The internal name of your SMS offer */
|
|
467
|
+
serviceName: string;
|
|
468
|
+
/** The virtual number */
|
|
469
|
+
number: string;
|
|
470
|
+
/** The sms coding */
|
|
471
|
+
charset?: SmsCharsetEnum | (string & {});
|
|
472
|
+
/** Deprecated: The sms class */
|
|
473
|
+
class?: SmsClassEnum | (string & {});
|
|
474
|
+
/** Deprecated: the coding is deduced from the message and its charset */
|
|
475
|
+
coding?: SmsCodingEnum | (string & {});
|
|
476
|
+
/** The time -in minute(s)- to wait before sending the message */
|
|
477
|
+
differedPeriod?: number;
|
|
478
|
+
/** The sms message */
|
|
479
|
+
message: string;
|
|
480
|
+
/** The priority of the message */
|
|
481
|
+
priority?: SmsPriorityEnum | (string & {});
|
|
482
|
+
/** The receivers list */
|
|
483
|
+
receivers?: CreateSmsVirtualNumberJobRequestReceiversList;
|
|
484
|
+
/** The receivers document url link in csv format */
|
|
485
|
+
receiversDocumentUrl?: string;
|
|
486
|
+
/** The receivers document slot id */
|
|
487
|
+
receiversSlotId?: string;
|
|
488
|
+
/** The identifier group tag */
|
|
489
|
+
tag?: string;
|
|
490
|
+
/** The maximum time -in minute(s)- before the message is dropped */
|
|
491
|
+
validityPeriod?: number;
|
|
492
|
+
}
|
|
493
|
+
export declare const CreateSmsVirtualNumberJobRequest: S.Schema<CreateSmsVirtualNumberJobRequest>;
|
|
494
|
+
export interface DeleteSmsBatchRequest {
|
|
495
|
+
/** The internal name of your SMS offer */
|
|
496
|
+
serviceName: string;
|
|
497
|
+
/** Id */
|
|
498
|
+
id: string;
|
|
499
|
+
}
|
|
500
|
+
export declare const DeleteSmsBatchRequest: S.Schema<DeleteSmsBatchRequest>;
|
|
501
|
+
export interface DeleteSmsBatchResponse {
|
|
502
|
+
}
|
|
503
|
+
export declare const DeleteSmsBatchResponse: S.Schema<DeleteSmsBatchResponse>;
|
|
504
|
+
export interface DeleteSmsBlacklistRequest {
|
|
505
|
+
/** The internal name of your SMS offer */
|
|
506
|
+
serviceName: string;
|
|
507
|
+
/** The sms number blacklisted */
|
|
508
|
+
number: string;
|
|
509
|
+
}
|
|
510
|
+
export declare const DeleteSmsBlacklistRequest: S.Schema<DeleteSmsBlacklistRequest>;
|
|
511
|
+
export interface DeleteSmsBlacklistResponse {
|
|
512
|
+
}
|
|
513
|
+
export declare const DeleteSmsBlacklistResponse: S.Schema<DeleteSmsBlacklistResponse>;
|
|
514
|
+
export interface DeleteSmsIncomingRequest {
|
|
515
|
+
/** The internal name of your SMS offer */
|
|
516
|
+
serviceName: string;
|
|
517
|
+
/** Id of the object */
|
|
518
|
+
id: number;
|
|
519
|
+
}
|
|
520
|
+
export declare const DeleteSmsIncomingRequest: S.Schema<DeleteSmsIncomingRequest>;
|
|
521
|
+
export interface DeleteSmsIncomingResponse {
|
|
522
|
+
}
|
|
523
|
+
export declare const DeleteSmsIncomingResponse: S.Schema<DeleteSmsIncomingResponse>;
|
|
524
|
+
export interface DeleteSmsJobRequest {
|
|
525
|
+
/** The internal name of your SMS offer */
|
|
526
|
+
serviceName: string;
|
|
527
|
+
/** Id of the object */
|
|
528
|
+
id: number;
|
|
529
|
+
}
|
|
530
|
+
export declare const DeleteSmsJobRequest: S.Schema<DeleteSmsJobRequest>;
|
|
531
|
+
export interface DeleteSmsJobResponse {
|
|
532
|
+
}
|
|
533
|
+
export declare const DeleteSmsJobResponse: S.Schema<DeleteSmsJobResponse>;
|
|
534
|
+
export interface DeleteSmsOutgoingRequest {
|
|
535
|
+
/** The internal name of your SMS offer */
|
|
536
|
+
serviceName: string;
|
|
537
|
+
/** Id */
|
|
538
|
+
id: number;
|
|
539
|
+
}
|
|
540
|
+
export declare const DeleteSmsOutgoingRequest: S.Schema<DeleteSmsOutgoingRequest>;
|
|
541
|
+
export interface DeleteSmsOutgoingResponse {
|
|
542
|
+
}
|
|
543
|
+
export declare const DeleteSmsOutgoingResponse: S.Schema<DeleteSmsOutgoingResponse>;
|
|
544
|
+
export interface DeleteSmsPhonebookRequest {
|
|
545
|
+
/** The internal name of your SMS offer */
|
|
546
|
+
serviceName: string;
|
|
547
|
+
/** Identifier of the phonebook */
|
|
548
|
+
bookKey: string;
|
|
549
|
+
}
|
|
550
|
+
export declare const DeleteSmsPhonebookRequest: S.Schema<DeleteSmsPhonebookRequest>;
|
|
551
|
+
export interface DeleteSmsPhonebookResponse {
|
|
552
|
+
}
|
|
553
|
+
export declare const DeleteSmsPhonebookResponse: S.Schema<DeleteSmsPhonebookResponse>;
|
|
554
|
+
export interface DeleteSmsPhonebookPhonebookContactRequest {
|
|
555
|
+
/** The internal name of your SMS offer */
|
|
556
|
+
serviceName: string;
|
|
557
|
+
/** Identifier of the phonebook */
|
|
558
|
+
bookKey: string;
|
|
559
|
+
/** Contact identifier */
|
|
560
|
+
id: number;
|
|
561
|
+
}
|
|
562
|
+
export declare const DeleteSmsPhonebookPhonebookContactRequest: S.Schema<DeleteSmsPhonebookPhonebookContactRequest>;
|
|
563
|
+
export interface DeleteSmsPhonebookPhonebookContactResponse {
|
|
564
|
+
}
|
|
565
|
+
export declare const DeleteSmsPhonebookPhonebookContactResponse: S.Schema<DeleteSmsPhonebookPhonebookContactResponse>;
|
|
566
|
+
export interface DeleteSmsReceiverRequest {
|
|
567
|
+
/** The internal name of your SMS offer */
|
|
568
|
+
serviceName: string;
|
|
569
|
+
/** Slot number id */
|
|
570
|
+
slotId: number;
|
|
571
|
+
}
|
|
572
|
+
export declare const DeleteSmsReceiverRequest: S.Schema<DeleteSmsReceiverRequest>;
|
|
573
|
+
export interface DeleteSmsReceiverResponse {
|
|
574
|
+
}
|
|
575
|
+
export declare const DeleteSmsReceiverResponse: S.Schema<DeleteSmsReceiverResponse>;
|
|
576
|
+
export interface DeleteSmsSenderRequest {
|
|
577
|
+
/** The internal name of your SMS offer */
|
|
578
|
+
serviceName: string;
|
|
579
|
+
/** The sms sender */
|
|
580
|
+
sender: string;
|
|
581
|
+
}
|
|
582
|
+
export declare const DeleteSmsSenderRequest: S.Schema<DeleteSmsSenderRequest>;
|
|
583
|
+
export interface DeleteSmsSenderResponse {
|
|
584
|
+
}
|
|
585
|
+
export declare const DeleteSmsSenderResponse: S.Schema<DeleteSmsSenderResponse>;
|
|
586
|
+
export interface DeleteSmsTemplatesControlRequest {
|
|
587
|
+
/** The internal name of your SMS offer */
|
|
588
|
+
serviceName: string;
|
|
589
|
+
/** Name of the template */
|
|
590
|
+
name: string;
|
|
591
|
+
}
|
|
592
|
+
export declare const DeleteSmsTemplatesControlRequest: S.Schema<DeleteSmsTemplatesControlRequest>;
|
|
593
|
+
export interface DeleteSmsTemplatesControlResponse {
|
|
594
|
+
}
|
|
595
|
+
export declare const DeleteSmsTemplatesControlResponse: S.Schema<DeleteSmsTemplatesControlResponse>;
|
|
596
|
+
export interface DeleteSmsUserRequest {
|
|
597
|
+
/** The internal name of your SMS offer */
|
|
598
|
+
serviceName: string;
|
|
599
|
+
/** The sms user login */
|
|
600
|
+
login: string;
|
|
601
|
+
}
|
|
602
|
+
export declare const DeleteSmsUserRequest: S.Schema<DeleteSmsUserRequest>;
|
|
603
|
+
export interface DeleteSmsUserResponse {
|
|
604
|
+
}
|
|
605
|
+
export declare const DeleteSmsUserResponse: S.Schema<DeleteSmsUserResponse>;
|
|
606
|
+
export interface DeleteSmsUserIncomingRequest {
|
|
607
|
+
/** The internal name of your SMS offer */
|
|
608
|
+
serviceName: string;
|
|
609
|
+
/** The sms user login */
|
|
610
|
+
login: string;
|
|
611
|
+
/** Id of the object */
|
|
612
|
+
id: number;
|
|
613
|
+
}
|
|
614
|
+
export declare const DeleteSmsUserIncomingRequest: S.Schema<DeleteSmsUserIncomingRequest>;
|
|
615
|
+
export interface DeleteSmsUserIncomingResponse {
|
|
616
|
+
}
|
|
617
|
+
export declare const DeleteSmsUserIncomingResponse: S.Schema<DeleteSmsUserIncomingResponse>;
|
|
618
|
+
export interface DeleteSmsUserJobRequest {
|
|
619
|
+
/** The internal name of your SMS offer */
|
|
620
|
+
serviceName: string;
|
|
621
|
+
/** The sms user login */
|
|
622
|
+
login: string;
|
|
623
|
+
/** Id of the object */
|
|
624
|
+
id: number;
|
|
625
|
+
}
|
|
626
|
+
export declare const DeleteSmsUserJobRequest: S.Schema<DeleteSmsUserJobRequest>;
|
|
627
|
+
export interface DeleteSmsUserJobResponse {
|
|
628
|
+
}
|
|
629
|
+
export declare const DeleteSmsUserJobResponse: S.Schema<DeleteSmsUserJobResponse>;
|
|
630
|
+
export interface DeleteSmsUserOutgoingRequest {
|
|
631
|
+
/** The internal name of your SMS offer */
|
|
632
|
+
serviceName: string;
|
|
633
|
+
/** The sms user login */
|
|
634
|
+
login: string;
|
|
635
|
+
/** Id of the object */
|
|
636
|
+
id: number;
|
|
637
|
+
}
|
|
638
|
+
export declare const DeleteSmsUserOutgoingRequest: S.Schema<DeleteSmsUserOutgoingRequest>;
|
|
639
|
+
export interface DeleteSmsUserOutgoingResponse {
|
|
640
|
+
}
|
|
641
|
+
export declare const DeleteSmsUserOutgoingResponse: S.Schema<DeleteSmsUserOutgoingResponse>;
|
|
642
|
+
export interface DeleteSmsUserReceiverRequest {
|
|
643
|
+
/** The internal name of your SMS offer */
|
|
644
|
+
serviceName: string;
|
|
645
|
+
/** The sms user login */
|
|
646
|
+
login: string;
|
|
647
|
+
/** Slot number id */
|
|
648
|
+
slotId: number;
|
|
649
|
+
}
|
|
650
|
+
export declare const DeleteSmsUserReceiverRequest: S.Schema<DeleteSmsUserReceiverRequest>;
|
|
651
|
+
export interface DeleteSmsUserReceiverResponse {
|
|
652
|
+
}
|
|
653
|
+
export declare const DeleteSmsUserReceiverResponse: S.Schema<DeleteSmsUserReceiverResponse>;
|
|
654
|
+
export interface DeleteSmsVirtualNumberChatAccessRequest {
|
|
655
|
+
/** The internal name of your SMS offer */
|
|
656
|
+
serviceName: string;
|
|
657
|
+
/** The virtual number */
|
|
658
|
+
number: string;
|
|
659
|
+
}
|
|
660
|
+
export declare const DeleteSmsVirtualNumberChatAccessRequest: S.Schema<DeleteSmsVirtualNumberChatAccessRequest>;
|
|
661
|
+
export interface DeleteSmsVirtualNumberChatAccessResponse {
|
|
662
|
+
}
|
|
663
|
+
export declare const DeleteSmsVirtualNumberChatAccessResponse: S.Schema<DeleteSmsVirtualNumberChatAccessResponse>;
|
|
664
|
+
export interface DeleteSmsVirtualNumberIncomingRequest {
|
|
665
|
+
/** The internal name of your SMS offer */
|
|
666
|
+
serviceName: string;
|
|
667
|
+
/** The virtual number */
|
|
668
|
+
number: string;
|
|
669
|
+
/** Id of the object */
|
|
670
|
+
id: number;
|
|
671
|
+
}
|
|
672
|
+
export declare const DeleteSmsVirtualNumberIncomingRequest: S.Schema<DeleteSmsVirtualNumberIncomingRequest>;
|
|
673
|
+
export interface DeleteSmsVirtualNumberIncomingResponse {
|
|
674
|
+
}
|
|
675
|
+
export declare const DeleteSmsVirtualNumberIncomingResponse: S.Schema<DeleteSmsVirtualNumberIncomingResponse>;
|
|
676
|
+
export interface DeleteSmsVirtualNumberJobRequest {
|
|
677
|
+
/** The internal name of your SMS offer */
|
|
678
|
+
serviceName: string;
|
|
679
|
+
/** The virtual number */
|
|
680
|
+
number: string;
|
|
681
|
+
/** Id of the object */
|
|
682
|
+
id: number;
|
|
683
|
+
}
|
|
684
|
+
export declare const DeleteSmsVirtualNumberJobRequest: S.Schema<DeleteSmsVirtualNumberJobRequest>;
|
|
685
|
+
export interface DeleteSmsVirtualNumberJobResponse {
|
|
686
|
+
}
|
|
687
|
+
export declare const DeleteSmsVirtualNumberJobResponse: S.Schema<DeleteSmsVirtualNumberJobResponse>;
|
|
688
|
+
export interface DeleteSmsVirtualNumberOutgoingRequest {
|
|
689
|
+
/** The internal name of your SMS offer */
|
|
690
|
+
serviceName: string;
|
|
691
|
+
/** The virtual number */
|
|
692
|
+
number: string;
|
|
693
|
+
/** Id of the object */
|
|
694
|
+
id: number;
|
|
695
|
+
}
|
|
696
|
+
export declare const DeleteSmsVirtualNumberOutgoingRequest: S.Schema<DeleteSmsVirtualNumberOutgoingRequest>;
|
|
697
|
+
export interface DeleteSmsVirtualNumberOutgoingResponse {
|
|
698
|
+
}
|
|
699
|
+
export declare const DeleteSmsVirtualNumberOutgoingResponse: S.Schema<DeleteSmsVirtualNumberOutgoingResponse>;
|
|
700
|
+
export interface GetSmsRequest {
|
|
701
|
+
/** The internal name of your SMS offer */
|
|
702
|
+
serviceName: string;
|
|
703
|
+
}
|
|
704
|
+
export declare const GetSmsRequest: S.Schema<GetSmsRequest>;
|
|
705
|
+
/** Pack quantity automatic recredit possibilities */
|
|
706
|
+
export type SmsPackQuantityAutomaticRecreditEnum = 100 | 200 | 250 | 500 | 1000 | 5000 | 10000;
|
|
707
|
+
export declare const SmsPackQuantityAutomaticRecreditEnum: any;
|
|
708
|
+
/** In case of smpp the channel can not be "both" */
|
|
709
|
+
export type SmsChannelEnum = "both" | "marketing" | "transactional";
|
|
710
|
+
export declare const SmsChannelEnum: any;
|
|
711
|
+
/** Resource tags. Tags that were internally computed are prefixed with ovh: */
|
|
712
|
+
export type IamResourceMetadataTagsMap = {
|
|
713
|
+
[key: string]: string | undefined;
|
|
714
|
+
};
|
|
715
|
+
export declare const IamResourceMetadataTagsMap: S.Schema<IamResourceMetadataTagsMap>;
|
|
716
|
+
/** IAM resource metadata embedded in services models */
|
|
717
|
+
export interface IamResourceMetadata {
|
|
718
|
+
/** Resource display name */
|
|
719
|
+
displayName?: string | null;
|
|
720
|
+
/** Unique identifier of the resource */
|
|
721
|
+
id?: string;
|
|
722
|
+
/** Resource tags. Tags that were internally computed are prefixed with ovh: */
|
|
723
|
+
tags?: IamResourceMetadataTagsMap | null;
|
|
724
|
+
/** Unique resource name used in policies */
|
|
725
|
+
urn?: string;
|
|
726
|
+
}
|
|
727
|
+
export declare const IamResourceMetadata: S.Schema<IamResourceMetadata>;
|
|
728
|
+
/** Response type */
|
|
729
|
+
export type SmsResponseTypeEnum = "cgi" | "none" | "text";
|
|
730
|
+
export declare const SmsResponseTypeEnum: any;
|
|
731
|
+
/** The tracking media response */
|
|
732
|
+
export type SmsResponseTrackingMediaEnum = "email" | "sms" | "voice";
|
|
733
|
+
export declare const SmsResponseTrackingMediaEnum: any;
|
|
734
|
+
/** The tracking media response */
|
|
735
|
+
export interface SmsResponseTrackingOptions {
|
|
736
|
+
media?: SmsResponseTrackingMediaEnum | (string & {});
|
|
737
|
+
sender?: string;
|
|
738
|
+
target?: string;
|
|
739
|
+
}
|
|
740
|
+
export declare const SmsResponseTrackingOptions: S.Schema<SmsResponseTrackingOptions>;
|
|
741
|
+
export type SmsResponseTrackingOptionsList = Array<SmsResponseTrackingOptions>;
|
|
742
|
+
export declare const SmsResponseTrackingOptionsList: S.Schema<SmsResponseTrackingOptionsList>;
|
|
743
|
+
/** A structure describing how to manage an sms Response */
|
|
744
|
+
export interface SmsResponse {
|
|
745
|
+
/** Default url callback used for a given response. */
|
|
746
|
+
cgiUrl?: string | null;
|
|
747
|
+
responseType?: SmsResponseTypeEnum | (string & {});
|
|
748
|
+
/** Automatic notification sent by text in case of customer reply. */
|
|
749
|
+
text?: string | null;
|
|
750
|
+
trackingDefaultSmsSender?: string | null;
|
|
751
|
+
trackingOptions?: SmsResponseTrackingOptionsList | null;
|
|
752
|
+
}
|
|
753
|
+
export declare const SmsResponse: S.Schema<SmsResponse>;
|
|
754
|
+
/** Account status */
|
|
755
|
+
export type SmsStatusAccountEnum = "disable" | "enable";
|
|
756
|
+
export declare const SmsStatusAccountEnum: any;
|
|
757
|
+
/** A structure describing all information about templates informations */
|
|
758
|
+
export interface SmsTemplates {
|
|
759
|
+
customizedEmailMode?: boolean;
|
|
760
|
+
customizedSmsMode?: boolean;
|
|
761
|
+
emailBody?: string | null;
|
|
762
|
+
emailFrom?: string | null;
|
|
763
|
+
emailSubject?: string | null;
|
|
764
|
+
smsBody?: string | null;
|
|
765
|
+
time2chatAutomaticResponse?: string | null;
|
|
766
|
+
}
|
|
767
|
+
export declare const SmsTemplates: S.Schema<SmsTemplates>;
|
|
768
|
+
/** SMS details */
|
|
769
|
+
export interface SmsAccountWithIAM {
|
|
770
|
+
automaticRecreditAmount?: SmsPackQuantityAutomaticRecreditEnum | null;
|
|
771
|
+
/** URL called when state of a sent SMS changes */
|
|
772
|
+
callBack?: string | null;
|
|
773
|
+
/** For what purpose this account can be used for */
|
|
774
|
+
channel?: SmsChannelEnum;
|
|
775
|
+
/** Credit threshold after which an automatic recredit is launched */
|
|
776
|
+
creditThresholdForAutomaticRecredit?: number;
|
|
777
|
+
creditsHoldByQuota?: number;
|
|
778
|
+
creditsLeft?: number;
|
|
779
|
+
description?: string;
|
|
780
|
+
/** IAM resource metadata */
|
|
781
|
+
iam?: IamResourceMetadata | null;
|
|
782
|
+
name?: string;
|
|
783
|
+
/** Whether the account can be used for smpp or not */
|
|
784
|
+
smpp?: boolean;
|
|
785
|
+
smsResponse?: SmsResponse;
|
|
786
|
+
status?: SmsStatusAccountEnum;
|
|
787
|
+
/** URL called when a STOP is received after a receiver replied stop to a SMS */
|
|
788
|
+
stopCallBack?: string | null;
|
|
789
|
+
templates?: SmsTemplates;
|
|
790
|
+
userQuantityWithQuota?: number;
|
|
791
|
+
}
|
|
792
|
+
export declare const SmsAccountWithIAM: S.Schema<SmsAccountWithIAM>;
|
|
793
|
+
export interface GetSmsBatchRequest {
|
|
794
|
+
/** The internal name of your SMS offer */
|
|
795
|
+
serviceName: string;
|
|
796
|
+
/** Id */
|
|
797
|
+
id: string;
|
|
798
|
+
}
|
|
799
|
+
export declare const GetSmsBatchRequest: S.Schema<GetSmsBatchRequest>;
|
|
800
|
+
export interface GetSmsBatchStatisticsRequest {
|
|
801
|
+
/** The internal name of your SMS offer */
|
|
802
|
+
serviceName: string;
|
|
803
|
+
/** Id */
|
|
804
|
+
id: string;
|
|
805
|
+
}
|
|
806
|
+
export declare const GetSmsBatchStatisticsRequest: S.Schema<GetSmsBatchStatisticsRequest>;
|
|
807
|
+
/** Batch's statistics */
|
|
808
|
+
export interface SmsBatchStatistics {
|
|
809
|
+
/** The cost of the batch in credits, computed during batch processing */
|
|
810
|
+
credits?: number;
|
|
811
|
+
/** Number of SMS that are delivered */
|
|
812
|
+
delivered?: number;
|
|
813
|
+
/** The estimated cost of the batch in credits, computed before batch processing */
|
|
814
|
+
estimatedCredits?: number;
|
|
815
|
+
/** Number of SMS in error */
|
|
816
|
+
failed?: number;
|
|
817
|
+
/** Batch ID */
|
|
818
|
+
id?: string;
|
|
819
|
+
/** Number of SMS that are in pending status */
|
|
820
|
+
pending?: number;
|
|
821
|
+
/** Number of SMS that are sent to the broker */
|
|
822
|
+
sent?: number;
|
|
823
|
+
/** Number of SMS that received a STOP by the receiver */
|
|
824
|
+
stoplisted?: number;
|
|
825
|
+
}
|
|
826
|
+
export declare const SmsBatchStatistics: S.Schema<SmsBatchStatistics>;
|
|
827
|
+
export interface GetSmsBlacklistRequest {
|
|
828
|
+
/** The internal name of your SMS offer */
|
|
829
|
+
serviceName: string;
|
|
830
|
+
/** The sms number blacklisted */
|
|
831
|
+
number: string;
|
|
832
|
+
}
|
|
833
|
+
export declare const GetSmsBlacklistRequest: S.Schema<GetSmsBlacklistRequest>;
|
|
834
|
+
/** SMS blacklist */
|
|
835
|
+
export interface SmsBlacklist {
|
|
836
|
+
/** ID of the batch responsible of the blacklist */
|
|
837
|
+
batchID?: string | null;
|
|
838
|
+
dateCreation?: string;
|
|
839
|
+
/** The sms number blacklisted */
|
|
840
|
+
number?: string;
|
|
841
|
+
/** ID of the outgoing SMS responsible of the blacklist */
|
|
842
|
+
smsOutgoingID?: number | null;
|
|
843
|
+
}
|
|
844
|
+
export declare const SmsBlacklist: S.Schema<SmsBlacklist>;
|
|
845
|
+
/** Way type */
|
|
846
|
+
export type SmsDocumentWayTypeEnum = "incoming" | "outgoing";
|
|
847
|
+
export declare const SmsDocumentWayTypeEnum: any;
|
|
848
|
+
export interface GetSmsDocumentRequest {
|
|
849
|
+
/** The internal name of your SMS offer */
|
|
850
|
+
serviceName: string;
|
|
851
|
+
/** Filter SMSs with their batch ID (outgoing SMSs only) */
|
|
852
|
+
batchID?: string;
|
|
853
|
+
/** Filter the value of creationDatetime property (>=) */
|
|
854
|
+
creationDatetime_from?: string;
|
|
855
|
+
/** Filter the value of creationDatetime property (<=) */
|
|
856
|
+
creationDatetime_to?: string;
|
|
857
|
+
/** Select sms with a specific identifier group tag */
|
|
858
|
+
tag?: string;
|
|
859
|
+
/** specify outgoing or incoming sms */
|
|
860
|
+
wayType: SmsDocumentWayTypeEnum | (string & {});
|
|
861
|
+
}
|
|
862
|
+
export declare const GetSmsDocumentRequest: S.Schema<GetSmsDocumentRequest>;
|
|
863
|
+
export type GetSmsDocumentResponse = string;
|
|
864
|
+
export declare const GetSmsDocumentResponse: S.Schema<GetSmsDocumentResponse>;
|
|
865
|
+
export interface GetSmsHlrRequest {
|
|
866
|
+
/** The internal name of your SMS offer */
|
|
867
|
+
serviceName: string;
|
|
868
|
+
/** HLR id */
|
|
869
|
+
id: number;
|
|
870
|
+
}
|
|
871
|
+
export declare const GetSmsHlrRequest: S.Schema<GetSmsHlrRequest>;
|
|
872
|
+
/** The sms coding */
|
|
873
|
+
export type SmsHlrStatuses = "doing" | "done" | "error" | "todo";
|
|
874
|
+
export declare const SmsHlrStatuses: any;
|
|
875
|
+
/** Home Location Register informations. Give informations about a given cellular phone. */
|
|
876
|
+
export interface SmsHlrLookupNumber {
|
|
877
|
+
/** HLR creation datetime */
|
|
878
|
+
datetime?: string;
|
|
879
|
+
/** HLR id */
|
|
880
|
+
id?: number;
|
|
881
|
+
/** MSISDN */
|
|
882
|
+
msisdn?: string;
|
|
883
|
+
/** The {Mobile Country Code, Mobile Network Code} unique identifier */
|
|
884
|
+
operatorCode?: string;
|
|
885
|
+
/** Has the MSISDN been ported from its original network */
|
|
886
|
+
ported?: boolean;
|
|
887
|
+
/** Is the MSISDN currently reachable */
|
|
888
|
+
reachable?: boolean;
|
|
889
|
+
/** Is the MSISDN currently roaming outside its natinal network */
|
|
890
|
+
roaming?: boolean;
|
|
891
|
+
/** Status of the HLR request */
|
|
892
|
+
status?: SmsHlrStatuses;
|
|
893
|
+
/** Is the MSISDN valid */
|
|
894
|
+
valid?: boolean;
|
|
895
|
+
}
|
|
896
|
+
export declare const SmsHlrLookupNumber: S.Schema<SmsHlrLookupNumber>;
|
|
897
|
+
export interface GetSmsHlrOperatorRequest {
|
|
898
|
+
/** The internal name of your SMS offer */
|
|
899
|
+
serviceName: string;
|
|
900
|
+
/** HLR id */
|
|
901
|
+
id: number;
|
|
902
|
+
}
|
|
903
|
+
export declare const GetSmsHlrOperatorRequest: S.Schema<GetSmsHlrOperatorRequest>;
|
|
904
|
+
/** Sms operator informations */
|
|
905
|
+
export interface SmsHlr {
|
|
906
|
+
/** The country */
|
|
907
|
+
country?: string;
|
|
908
|
+
/** The countryCode prefix number */
|
|
909
|
+
countryCode?: string;
|
|
910
|
+
/** The network name */
|
|
911
|
+
network?: string;
|
|
912
|
+
/** The operator name */
|
|
913
|
+
operator?: string;
|
|
914
|
+
/** The region */
|
|
915
|
+
region?: string;
|
|
916
|
+
}
|
|
917
|
+
export declare const SmsHlr: S.Schema<SmsHlr>;
|
|
918
|
+
export interface GetSmsIncomingRequest {
|
|
919
|
+
/** The internal name of your SMS offer */
|
|
920
|
+
serviceName: string;
|
|
921
|
+
/** Id of the object */
|
|
922
|
+
id: number;
|
|
923
|
+
}
|
|
924
|
+
export declare const GetSmsIncomingRequest: S.Schema<GetSmsIncomingRequest>;
|
|
925
|
+
/** Sms history of sms incoming received */
|
|
926
|
+
export interface SmsIncoming {
|
|
927
|
+
creationDatetime?: string;
|
|
928
|
+
credits?: number;
|
|
929
|
+
id?: number;
|
|
930
|
+
message?: string;
|
|
931
|
+
sender?: string;
|
|
932
|
+
tag?: string;
|
|
933
|
+
}
|
|
934
|
+
export declare const SmsIncoming: S.Schema<SmsIncoming>;
|
|
935
|
+
export interface GetSmsJobRequest {
|
|
936
|
+
/** The internal name of your SMS offer */
|
|
937
|
+
serviceName: string;
|
|
938
|
+
/** Id of the object */
|
|
939
|
+
id: number;
|
|
940
|
+
}
|
|
941
|
+
export declare const GetSmsJobRequest: S.Schema<GetSmsJobRequest>;
|
|
942
|
+
/** Sms job */
|
|
943
|
+
export interface SmsJob {
|
|
944
|
+
creationDatetime?: string;
|
|
945
|
+
credits?: number;
|
|
946
|
+
deliveredAt?: string | null;
|
|
947
|
+
deliveryReceipt?: number;
|
|
948
|
+
differedDelivery?: number;
|
|
949
|
+
id?: number;
|
|
950
|
+
message?: string;
|
|
951
|
+
messageLength?: number;
|
|
952
|
+
numberOfSms?: number;
|
|
953
|
+
ptt?: number;
|
|
954
|
+
receiver?: string;
|
|
955
|
+
sender?: string;
|
|
956
|
+
sentAt?: string | null;
|
|
957
|
+
}
|
|
958
|
+
export declare const SmsJob: S.Schema<SmsJob>;
|
|
959
|
+
export interface GetSmsOutgoingRequest {
|
|
960
|
+
/** The internal name of your SMS offer */
|
|
961
|
+
serviceName: string;
|
|
962
|
+
/** Id */
|
|
963
|
+
id: number;
|
|
964
|
+
}
|
|
965
|
+
export declare const GetSmsOutgoingRequest: S.Schema<GetSmsOutgoingRequest>;
|
|
966
|
+
/** Sent SMS */
|
|
967
|
+
export interface SmsOutgoing {
|
|
968
|
+
/** ID of batch linked to the SMS */
|
|
969
|
+
batchID?: string | null;
|
|
970
|
+
/** Creation datetime */
|
|
971
|
+
creationDatetime?: string;
|
|
972
|
+
/** Spent credits */
|
|
973
|
+
credits?: number;
|
|
974
|
+
/** Delivering datetime */
|
|
975
|
+
deliveredAt?: string | null;
|
|
976
|
+
/** Delivery receipt from operator */
|
|
977
|
+
deliveryReceipt?: number;
|
|
978
|
+
/** Delay before SMS sending */
|
|
979
|
+
differedDelivery?: number;
|
|
980
|
+
/** Identifier */
|
|
981
|
+
id?: number;
|
|
982
|
+
/** SMS message */
|
|
983
|
+
message?: string;
|
|
984
|
+
/** SMPP messageID */
|
|
985
|
+
messageID?: string | null;
|
|
986
|
+
/** SMS message length */
|
|
987
|
+
messageLength?: number;
|
|
988
|
+
/** SMS message's number of parts */
|
|
989
|
+
numberOfSms?: number;
|
|
990
|
+
/** Code representing SMS state */
|
|
991
|
+
ptt?: number;
|
|
992
|
+
/** SMS receiver */
|
|
993
|
+
receiver?: string;
|
|
994
|
+
/** SMS sender */
|
|
995
|
+
sender?: string;
|
|
996
|
+
/** Sending datetime */
|
|
997
|
+
sentAt?: string | null;
|
|
998
|
+
/** Customer label to categorize SMSs */
|
|
999
|
+
tag?: string;
|
|
1000
|
+
/** Tariff code applied on the sms */
|
|
1001
|
+
tariffCode?: string;
|
|
1002
|
+
}
|
|
1003
|
+
export declare const SmsOutgoing: S.Schema<SmsOutgoing>;
|
|
1004
|
+
export interface GetSmsOutgoingHlrRequest {
|
|
1005
|
+
/** The internal name of your SMS offer */
|
|
1006
|
+
serviceName: string;
|
|
1007
|
+
/** Id of the object */
|
|
1008
|
+
id: number;
|
|
1009
|
+
}
|
|
1010
|
+
export declare const GetSmsOutgoingHlrRequest: S.Schema<GetSmsOutgoingHlrRequest>;
|
|
1011
|
+
export interface GetSmsPhonebookRequest {
|
|
1012
|
+
/** The internal name of your SMS offer */
|
|
1013
|
+
serviceName: string;
|
|
1014
|
+
/** Identifier of the phonebook */
|
|
1015
|
+
bookKey: string;
|
|
1016
|
+
}
|
|
1017
|
+
export declare const GetSmsPhonebookRequest: S.Schema<GetSmsPhonebookRequest>;
|
|
1018
|
+
/** Phone book */
|
|
1019
|
+
export interface SmsPhonebook {
|
|
1020
|
+
/** Identifier of the phonebook */
|
|
1021
|
+
bookKey?: string;
|
|
1022
|
+
/** Phonebook name */
|
|
1023
|
+
name?: string;
|
|
1024
|
+
/** Phone key identifier between the phone and phonebooks */
|
|
1025
|
+
phoneKey?: string;
|
|
1026
|
+
}
|
|
1027
|
+
export declare const SmsPhonebook: S.Schema<SmsPhonebook>;
|
|
1028
|
+
/** Export file format */
|
|
1029
|
+
export type TelephonyContactsExportFormatsEnum = "csv";
|
|
1030
|
+
export declare const TelephonyContactsExportFormatsEnum: any;
|
|
1031
|
+
export interface GetSmsPhonebookExportRequest {
|
|
1032
|
+
/** The internal name of your SMS offer */
|
|
1033
|
+
serviceName: string;
|
|
1034
|
+
/** Identifier of the phonebook */
|
|
1035
|
+
bookKey: string;
|
|
1036
|
+
/** Format of the file */
|
|
1037
|
+
format: TelephonyContactsExportFormatsEnum | (string & {});
|
|
1038
|
+
}
|
|
1039
|
+
export declare const GetSmsPhonebookExportRequest: S.Schema<GetSmsPhonebookExportRequest>;
|
|
1040
|
+
/** File providing task status */
|
|
1041
|
+
export type TelephonyPcsFileStatusEnum = "doing" | "done" | "error" | "todo";
|
|
1042
|
+
export declare const TelephonyPcsFileStatusEnum: any;
|
|
1043
|
+
/** Telephony API related file hosted */
|
|
1044
|
+
export interface TelephonyPcsFile {
|
|
1045
|
+
filename?: string;
|
|
1046
|
+
status?: TelephonyPcsFileStatusEnum;
|
|
1047
|
+
url?: string;
|
|
1048
|
+
urlExpirationDatetime?: string;
|
|
1049
|
+
}
|
|
1050
|
+
export declare const TelephonyPcsFile: S.Schema<TelephonyPcsFile>;
|
|
1051
|
+
export interface GetSmsPhonebookPhonebookContactRequest {
|
|
1052
|
+
/** The internal name of your SMS offer */
|
|
1053
|
+
serviceName: string;
|
|
1054
|
+
/** Identifier of the phonebook */
|
|
1055
|
+
bookKey: string;
|
|
1056
|
+
/** Contact identifier */
|
|
1057
|
+
id: number;
|
|
1058
|
+
}
|
|
1059
|
+
export declare const GetSmsPhonebookPhonebookContactRequest: S.Schema<GetSmsPhonebookPhonebookContactRequest>;
|
|
1060
|
+
/** Phone book contact */
|
|
1061
|
+
export interface SmsPhonebookContact {
|
|
1062
|
+
/** Group name of the phonebook */
|
|
1063
|
+
group?: string;
|
|
1064
|
+
/** Home mobile phone number of the contact */
|
|
1065
|
+
homeMobile?: string | null;
|
|
1066
|
+
/** Home landline phone number of the contact */
|
|
1067
|
+
homePhone?: string | null;
|
|
1068
|
+
/** Contact identifier */
|
|
1069
|
+
id?: number;
|
|
1070
|
+
/** Contact name */
|
|
1071
|
+
name?: string;
|
|
1072
|
+
/** Contact surname */
|
|
1073
|
+
surname?: string;
|
|
1074
|
+
/** Mobile phone office number of the contact */
|
|
1075
|
+
workMobile?: string | null;
|
|
1076
|
+
/** Landline phone office number of the contact */
|
|
1077
|
+
workPhone?: string | null;
|
|
1078
|
+
}
|
|
1079
|
+
export declare const SmsPhonebookContact: S.Schema<SmsPhonebookContact>;
|
|
1080
|
+
export interface GetSmsPttsRequest {
|
|
1081
|
+
/** The premium transaction tracking code */
|
|
1082
|
+
ptt: number;
|
|
1083
|
+
}
|
|
1084
|
+
export declare const GetSmsPttsRequest: S.Schema<GetSmsPttsRequest>;
|
|
1085
|
+
/** All typology of ptt duration */
|
|
1086
|
+
export type SmsPttDurationTypeEnum = "indeterminated" | "permanent" | "temporary";
|
|
1087
|
+
export declare const SmsPttDurationTypeEnum: any;
|
|
1088
|
+
/** A structure describing ptt details */
|
|
1089
|
+
export interface SmsPttDetails {
|
|
1090
|
+
/** Ptt informations */
|
|
1091
|
+
comment?: string;
|
|
1092
|
+
/** Ptt short description */
|
|
1093
|
+
description?: string;
|
|
1094
|
+
/** Ptt volatility type */
|
|
1095
|
+
duration?: SmsPttDurationTypeEnum;
|
|
1096
|
+
}
|
|
1097
|
+
export declare const SmsPttDetails: S.Schema<SmsPttDetails>;
|
|
1098
|
+
/** Countries where we sell SMS credits */
|
|
1099
|
+
export type SmsBillingCountryEnum = "es" | "fr" | "gb" | "ie" | "it" | "pl";
|
|
1100
|
+
export declare const SmsBillingCountryEnum: any;
|
|
1101
|
+
/** All country suffixes accessible for sms services and "all" available */
|
|
1102
|
+
export type SmsCountryEnum = "ad" | "ae" | "af" | "ag" | "ai" | "al" | "all" | "am" | "an" | "ao" | "ar" | "at" | "au" | "aw" | "az" | "ba" | "bb" | "bd" | "be" | "bf" | "bg" | "bh" | "bi" | "bj" | "bm" | "bn" | "bo" | "br" | "bs" | "bt" | "bw" | "by" | "bz" | "ca" | "cd" | "cf" | "cg" | "ch" | "ci" | "ck" | "cl" | "cm" | "cn" | "co" | "cr" | "cu" | "cv" | "cy" | "cz" | "de" | "dk" | "dm" | "dz" | "ec" | "ee" | "eg" | "es" | "et" | "fi" | "fj" | "fk" | "fo" | "fr" | "ga" | "gb" | "gd" | "ge" | "gf" | "gh" | "gi" | "gl" | "gm" | "gn" | "gp" | "gq" | "gr" | "gt" | "gu" | "gw" | "gy" | "hk" | "hn" | "hr" | "ht" | "hu" | "id" | "ie" | "il" | "in" | "io" | "iq" | "ir" | "is" | "it" | "jm" | "jo" | "jp" | "ke" | "kg" | "kh" | "km" | "kn" | "kr" | "kw" | "ky" | "kz" | "la" | "lb" | "lc" | "li" | "lk" | "lr" | "ls" | "lt" | "lu" | "lv" | "ly" | "ma" | "md" | "me" | "mg" | "mk" | "ml" | "mn" | "mo" | "mq" | "mr" | "ms" | "mt" | "mu" | "mv" | "mw" | "mx" | "my" | "mz" | "na" | "nc" | "ne" | "ng" | "ni" | "nl" | "no" | "np" | "nz" | "om" | "pa" | "pe" | "pf" | "pg" | "ph" | "pk" | "pl" | "ps" | "pt" | "py" | "qa" | "re" | "ro" | "rs" | "ru" | "rw" | "sa" | "sb" | "sc" | "sd" | "se" | "sg" | "si" | "sk" | "sl" | "sm" | "sn" | "so" | "sr" | "st" | "sv" | "sy" | "sz" | "tc" | "td" | "tg" | "th" | "tj" | "tl" | "tm" | "tn" | "to" | "tr" | "tt" | "tw" | "tz" | "ua" | "ug" | "us" | "uy" | "uz" | "vc" | "ve" | "vg" | "vi" | "vn" | "vu" | "ws" | "ye" | "yt" | "za" | "zm" | "zw";
|
|
1103
|
+
export declare const SmsCountryEnum: any;
|
|
1104
|
+
export interface GetSmsRateDestinationsRequest {
|
|
1105
|
+
/** Country where you buy credits */
|
|
1106
|
+
billingCountry?: SmsBillingCountryEnum | (string & {});
|
|
1107
|
+
/** Country where you send SMS */
|
|
1108
|
+
country: SmsCountryEnum | (string & {});
|
|
1109
|
+
}
|
|
1110
|
+
export declare const GetSmsRateDestinationsRequest: S.Schema<GetSmsRateDestinationsRequest>;
|
|
1111
|
+
export type OrderCurrencyCodeEnum = "AUD" | "CAD" | "CZK" | "EUR" | "GBP" | "INR" | "LTL" | "MAD" | "N/A" | "PLN" | "SGD" | "TND" | "USD" | "XOF" | "points";
|
|
1112
|
+
export declare const OrderCurrencyCodeEnum: any;
|
|
1113
|
+
/** Price with it's currency and textual representation */
|
|
1114
|
+
export interface OrderPrice {
|
|
1115
|
+
currencyCode?: OrderCurrencyCodeEnum;
|
|
1116
|
+
text?: string;
|
|
1117
|
+
value?: number;
|
|
1118
|
+
}
|
|
1119
|
+
export declare const OrderPrice: S.Schema<OrderPrice>;
|
|
1120
|
+
/** Rates of a given destination */
|
|
1121
|
+
export interface SmsDestinationRates {
|
|
1122
|
+
/** The country full name */
|
|
1123
|
+
country?: string;
|
|
1124
|
+
/** The country 2-letters code */
|
|
1125
|
+
countryCode?: SmsCountryEnum;
|
|
1126
|
+
/** Credits consumed by sending one SMS towards the given destination */
|
|
1127
|
+
credit?: number;
|
|
1128
|
+
/** Price of one SMS sent towards the given destination */
|
|
1129
|
+
price?: OrderPrice;
|
|
1130
|
+
}
|
|
1131
|
+
export declare const SmsDestinationRates: S.Schema<SmsDestinationRates>;
|
|
1132
|
+
export interface GetSmsReceiverRequest {
|
|
1133
|
+
/** The internal name of your SMS offer */
|
|
1134
|
+
serviceName: string;
|
|
1135
|
+
/** Slot number id */
|
|
1136
|
+
slotId: number;
|
|
1137
|
+
}
|
|
1138
|
+
export declare const GetSmsReceiverRequest: S.Schema<GetSmsReceiverRequest>;
|
|
1139
|
+
export interface GetSmsReceiverCsvRequest {
|
|
1140
|
+
/** The internal name of your SMS offer */
|
|
1141
|
+
serviceName: string;
|
|
1142
|
+
/** Slot number id */
|
|
1143
|
+
slotId: number;
|
|
1144
|
+
}
|
|
1145
|
+
export declare const GetSmsReceiverCsvRequest: S.Schema<GetSmsReceiverCsvRequest>;
|
|
1146
|
+
export type GetSmsReceiverCsvResponse = string;
|
|
1147
|
+
export declare const GetSmsReceiverCsvResponse: S.Schema<GetSmsReceiverCsvResponse>;
|
|
1148
|
+
export interface GetSmsSenderRequest {
|
|
1149
|
+
/** The internal name of your SMS offer */
|
|
1150
|
+
serviceName: string;
|
|
1151
|
+
/** The sms sender */
|
|
1152
|
+
sender: string;
|
|
1153
|
+
}
|
|
1154
|
+
export declare const GetSmsSenderRequest: S.Schema<GetSmsSenderRequest>;
|
|
1155
|
+
/** All tyoplogy of senders */
|
|
1156
|
+
export type SmsRefererSenderEnum = "custom" | "domain" | "line" | "nic" | "owner" | "virtual";
|
|
1157
|
+
export declare const SmsRefererSenderEnum: any;
|
|
1158
|
+
/** All existing status for a given referer */
|
|
1159
|
+
export type SmsStatusSenderEnum = "disable" | "enable" | "refused" | "waitingValidation";
|
|
1160
|
+
export declare const SmsStatusSenderEnum: any;
|
|
1161
|
+
/** SMS senders */
|
|
1162
|
+
export interface SmsSender {
|
|
1163
|
+
/** Message sent by the moderator */
|
|
1164
|
+
comment?: string | null;
|
|
1165
|
+
/** Sender description */
|
|
1166
|
+
description?: string;
|
|
1167
|
+
/** Specify if the sender is custom or not */
|
|
1168
|
+
referer?: SmsRefererSenderEnum;
|
|
1169
|
+
/** The sms sender */
|
|
1170
|
+
sender?: string;
|
|
1171
|
+
/** Sender status */
|
|
1172
|
+
status?: SmsStatusSenderEnum;
|
|
1173
|
+
/** Specify the kind of sender */
|
|
1174
|
+
type?: SmsTypeSenderEnum | null;
|
|
1175
|
+
/** Validation media identifier */
|
|
1176
|
+
validationMedia?: string | null;
|
|
1177
|
+
}
|
|
1178
|
+
export declare const SmsSender: S.Schema<SmsSender>;
|
|
1179
|
+
export interface GetSmsSenderDocumentRequest {
|
|
1180
|
+
/** The internal name of your SMS offer */
|
|
1181
|
+
serviceName: string;
|
|
1182
|
+
/** The sms sender */
|
|
1183
|
+
sender: string;
|
|
1184
|
+
/** Document ID */
|
|
1185
|
+
documentID: string;
|
|
1186
|
+
}
|
|
1187
|
+
export declare const GetSmsSenderDocumentRequest: S.Schema<GetSmsSenderDocumentRequest>;
|
|
1188
|
+
export interface GetSmsServiceInfosRequest {
|
|
1189
|
+
/** The internal name of your SMS offer */
|
|
1190
|
+
serviceName: string;
|
|
1191
|
+
}
|
|
1192
|
+
export declare const GetSmsServiceInfosRequest: S.Schema<GetSmsServiceInfosRequest>;
|
|
1193
|
+
/** All the possible renew period of your service in month */
|
|
1194
|
+
export type ServicesServicePossibleRenewPeriodList = Array<number>;
|
|
1195
|
+
export declare const ServicesServicePossibleRenewPeriodList: S.Schema<ServicesServicePossibleRenewPeriodList>;
|
|
1196
|
+
/** Map a possible renew for a specific service */
|
|
1197
|
+
export interface ServiceRenewType {
|
|
1198
|
+
/** The service is automatically renewed */
|
|
1199
|
+
automatic?: boolean;
|
|
1200
|
+
/** The service will be deleted at expiration */
|
|
1201
|
+
deleteAtExpiration?: boolean;
|
|
1202
|
+
/** The service forced to be renewed */
|
|
1203
|
+
forced?: boolean;
|
|
1204
|
+
/** The service needs to be manually renewed and paid */
|
|
1205
|
+
manualPayment?: boolean | null;
|
|
1206
|
+
/** period of renew in month */
|
|
1207
|
+
period?: number | null;
|
|
1208
|
+
}
|
|
1209
|
+
export declare const ServiceRenewType: S.Schema<ServiceRenewType>;
|
|
1210
|
+
/** Detailed renewal type of a service */
|
|
1211
|
+
export type ServiceRenewalTypeEnum = "automaticForcedProduct" | "automaticV2012" | "automaticV2014" | "automaticV2016" | "automaticV2024" | "manual" | "oneShot" | "option";
|
|
1212
|
+
export declare const ServiceRenewalTypeEnum: any;
|
|
1213
|
+
export type ServiceStateEnum = "autorenewInProgress" | "expired" | "inCreation" | "ok" | "pendingDebt" | "unPaid";
|
|
1214
|
+
export declare const ServiceStateEnum: any;
|
|
1215
|
+
/** Details about a Service */
|
|
1216
|
+
export interface ServicesService {
|
|
1217
|
+
/** Indicates that the service can be set up to be deleted at expiration */
|
|
1218
|
+
canDeleteAtExpiration?: boolean;
|
|
1219
|
+
contactAdmin?: string;
|
|
1220
|
+
contactBilling?: string;
|
|
1221
|
+
contactTech?: string;
|
|
1222
|
+
creation?: string;
|
|
1223
|
+
domain?: string;
|
|
1224
|
+
engagedUpTo?: string | null;
|
|
1225
|
+
expiration?: string;
|
|
1226
|
+
/** All the possible renew period of your service in month */
|
|
1227
|
+
possibleRenewPeriod?: ServicesServicePossibleRenewPeriodList | null;
|
|
1228
|
+
/** Way of handling the renew */
|
|
1229
|
+
renew?: ServiceRenewType | null;
|
|
1230
|
+
renewalType?: ServiceRenewalTypeEnum;
|
|
1231
|
+
serviceId?: number;
|
|
1232
|
+
status?: ServiceStateEnum;
|
|
1233
|
+
}
|
|
1234
|
+
export declare const ServicesService: S.Schema<ServicesService>;
|
|
1235
|
+
export interface GetSmsSmppSettingsRequest {
|
|
1236
|
+
/** The internal name of your SMS offer */
|
|
1237
|
+
serviceName: string;
|
|
1238
|
+
}
|
|
1239
|
+
export declare const GetSmsSmppSettingsRequest: S.Schema<GetSmsSmppSettingsRequest>;
|
|
1240
|
+
/** SMPP Settings Endpoints */
|
|
1241
|
+
export interface SmsSettingsEndpoints {
|
|
1242
|
+
/** address of the TLS endpoint: domain:port */
|
|
1243
|
+
secured?: string;
|
|
1244
|
+
/** address of the non-TLS endpoint: domain:port */
|
|
1245
|
+
unsecured?: string;
|
|
1246
|
+
}
|
|
1247
|
+
export declare const SmsSettingsEndpoints: S.Schema<SmsSettingsEndpoints>;
|
|
1248
|
+
/** Addresses of the TLS and non-TLS endpoints */
|
|
1249
|
+
export type SmsSettingsEndpointsList = Array<SmsSettingsEndpoints>;
|
|
1250
|
+
export declare const SmsSettingsEndpointsList: S.Schema<SmsSettingsEndpointsList>;
|
|
1251
|
+
/** Smpp Settings Statuses */
|
|
1252
|
+
export type SmsSettingsStatusEnum = "DELETED" | "ERROR" | "SUCCESS" | "UNKNOWN" | "UPDATING_IP" | "WAITING_IP";
|
|
1253
|
+
export declare const SmsSettingsStatusEnum: any;
|
|
1254
|
+
/** SMPP settings */
|
|
1255
|
+
export interface SmsSettings {
|
|
1256
|
+
/** Addresses of the TLS and non-TLS endpoints */
|
|
1257
|
+
endpoints?: SmsSettingsEndpointsList;
|
|
1258
|
+
/** Status of the SMPP account */
|
|
1259
|
+
status?: SmsSettingsStatusEnum;
|
|
1260
|
+
/** Username used to connect to OVHcloud SMSC */
|
|
1261
|
+
systemID?: string;
|
|
1262
|
+
/** Number of messages allowed per seconds */
|
|
1263
|
+
throughput?: number;
|
|
1264
|
+
/** Number of messages treated simultaneously */
|
|
1265
|
+
windowing?: number;
|
|
1266
|
+
}
|
|
1267
|
+
export declare const SmsSettings: S.Schema<SmsSettings>;
|
|
1268
|
+
export interface GetSmsTaskRequest {
|
|
1269
|
+
/** The internal name of your SMS offer */
|
|
1270
|
+
serviceName: string;
|
|
1271
|
+
taskId: number;
|
|
1272
|
+
}
|
|
1273
|
+
export declare const GetSmsTaskRequest: S.Schema<GetSmsTaskRequest>;
|
|
1274
|
+
/** The task function */
|
|
1275
|
+
export type SmsTodoGeneralPublicFunctionsEnum = "cleanSmsReceivers";
|
|
1276
|
+
export declare const SmsTodoGeneralPublicFunctionsEnum: any;
|
|
1277
|
+
/** Task status */
|
|
1278
|
+
export type TelephonyTaskStatusEnum = "doing" | "done" | "error" | "pause" | "todo";
|
|
1279
|
+
export declare const TelephonyTaskStatusEnum: any;
|
|
1280
|
+
/** The task step */
|
|
1281
|
+
export type SmsTodoGeneralPublicStepsEnum = "checkOrder" | "createHlrs" | "finishing" | "sendMailReport" | "starting" | "waitForHlrs";
|
|
1282
|
+
export declare const SmsTodoGeneralPublicStepsEnum: any;
|
|
1283
|
+
/** Operation on a SMS service */
|
|
1284
|
+
export interface SmsTask {
|
|
1285
|
+
function?: SmsTodoGeneralPublicFunctionsEnum;
|
|
1286
|
+
status?: TelephonyTaskStatusEnum;
|
|
1287
|
+
step?: SmsTodoGeneralPublicStepsEnum;
|
|
1288
|
+
taskId?: number;
|
|
1289
|
+
}
|
|
1290
|
+
export declare const SmsTask: S.Schema<SmsTask>;
|
|
1291
|
+
export interface GetSmsTemplatesControlRequest {
|
|
1292
|
+
/** The internal name of your SMS offer */
|
|
1293
|
+
serviceName: string;
|
|
1294
|
+
/** Name of the template */
|
|
1295
|
+
name: string;
|
|
1296
|
+
}
|
|
1297
|
+
export declare const GetSmsTemplatesControlRequest: S.Schema<GetSmsTemplatesControlRequest>;
|
|
1298
|
+
/** Sms template for moderation (Needed to send in US country) */
|
|
1299
|
+
export interface SmsTemplateControl {
|
|
1300
|
+
/** Specify the kind of template */
|
|
1301
|
+
activity?: SmsTypeTemplateEnum;
|
|
1302
|
+
/** Message sent by the moderator */
|
|
1303
|
+
comment?: string;
|
|
1304
|
+
/** Template creation datetime */
|
|
1305
|
+
datetime?: string;
|
|
1306
|
+
/** Template description */
|
|
1307
|
+
description?: string;
|
|
1308
|
+
/** Message pattern to be moderated. Use "#VALUE#" format for dynamic text area. */
|
|
1309
|
+
message?: string;
|
|
1310
|
+
/** Name of the template */
|
|
1311
|
+
name?: string;
|
|
1312
|
+
/** Template status */
|
|
1313
|
+
status?: SmsStatusSenderEnum;
|
|
1314
|
+
}
|
|
1315
|
+
export declare const SmsTemplateControl: S.Schema<SmsTemplateControl>;
|
|
1316
|
+
export interface GetSmsUserRequest {
|
|
1317
|
+
/** The internal name of your SMS offer */
|
|
1318
|
+
serviceName: string;
|
|
1319
|
+
/** The sms user login */
|
|
1320
|
+
login: string;
|
|
1321
|
+
}
|
|
1322
|
+
export declare const GetSmsUserRequest: S.Schema<GetSmsUserRequest>;
|
|
1323
|
+
/** The media support used to be contacted in case of alert */
|
|
1324
|
+
export type SmsSupportEnum = "both" | "mail" | "sms";
|
|
1325
|
+
export declare const SmsSupportEnum: any;
|
|
1326
|
+
/** A structure describing all information about alert threshold informations */
|
|
1327
|
+
export interface SmsAlertThreshold {
|
|
1328
|
+
alertEmail?: string;
|
|
1329
|
+
alertNumber?: string;
|
|
1330
|
+
alertThreshold?: number;
|
|
1331
|
+
support?: SmsSupportEnum | (string & {});
|
|
1332
|
+
}
|
|
1333
|
+
export declare const SmsAlertThreshold: S.Schema<SmsAlertThreshold>;
|
|
1334
|
+
export type SmsUserIpRestrictionsList = Array<string>;
|
|
1335
|
+
export declare const SmsUserIpRestrictionsList: S.Schema<SmsUserIpRestrictionsList>;
|
|
1336
|
+
/** Current quota status */
|
|
1337
|
+
export type SmsQuotaStatusUserEnum = "active" | "inactive";
|
|
1338
|
+
export declare const SmsQuotaStatusUserEnum: any;
|
|
1339
|
+
/** A structure describing all information about quota informations */
|
|
1340
|
+
export interface SmsQuota {
|
|
1341
|
+
quotaLeft?: number;
|
|
1342
|
+
quotaStatus?: SmsQuotaStatusUserEnum | (string & {});
|
|
1343
|
+
}
|
|
1344
|
+
export declare const SmsQuota: S.Schema<SmsQuota>;
|
|
1345
|
+
/** SMS users */
|
|
1346
|
+
export interface SmsUser {
|
|
1347
|
+
alertThresholdInformations?: SmsAlertThreshold;
|
|
1348
|
+
/** URL called when state of a sent SMS changes */
|
|
1349
|
+
callBack?: string | null;
|
|
1350
|
+
ipRestrictions?: SmsUserIpRestrictionsList;
|
|
1351
|
+
/** The sms user login */
|
|
1352
|
+
login?: string;
|
|
1353
|
+
password?: string | Redacted.Redacted<string>;
|
|
1354
|
+
quotaInformations?: SmsQuota;
|
|
1355
|
+
/** URL called when a STOP is received after a receiver replied stop to a SMS */
|
|
1356
|
+
stopCallBack?: string | null;
|
|
1357
|
+
}
|
|
1358
|
+
export declare const SmsUser: S.Schema<SmsUser>;
|
|
1359
|
+
export interface GetSmsUserDocumentRequest {
|
|
1360
|
+
/** The internal name of your SMS offer */
|
|
1361
|
+
serviceName: string;
|
|
1362
|
+
/** The sms user login */
|
|
1363
|
+
login: string;
|
|
1364
|
+
/** Filter the value of creationDatetime property (>=) */
|
|
1365
|
+
creationDatetime_from?: string;
|
|
1366
|
+
/** Filter the value of creationDatetime property (<=) */
|
|
1367
|
+
creationDatetime_to?: string;
|
|
1368
|
+
/** Select sms with a specific identifier group tag */
|
|
1369
|
+
tag?: string;
|
|
1370
|
+
/** specify outgoing or incoming sms */
|
|
1371
|
+
wayType: SmsDocumentWayTypeEnum | (string & {});
|
|
1372
|
+
}
|
|
1373
|
+
export declare const GetSmsUserDocumentRequest: S.Schema<GetSmsUserDocumentRequest>;
|
|
1374
|
+
export type GetSmsUserDocumentResponse = string;
|
|
1375
|
+
export declare const GetSmsUserDocumentResponse: S.Schema<GetSmsUserDocumentResponse>;
|
|
1376
|
+
export interface GetSmsUserIncomingRequest {
|
|
1377
|
+
/** The internal name of your SMS offer */
|
|
1378
|
+
serviceName: string;
|
|
1379
|
+
/** The sms user login */
|
|
1380
|
+
login: string;
|
|
1381
|
+
/** Id of the object */
|
|
1382
|
+
id: number;
|
|
1383
|
+
}
|
|
1384
|
+
export declare const GetSmsUserIncomingRequest: S.Schema<GetSmsUserIncomingRequest>;
|
|
1385
|
+
export interface GetSmsUserJobRequest {
|
|
1386
|
+
/** The internal name of your SMS offer */
|
|
1387
|
+
serviceName: string;
|
|
1388
|
+
/** The sms user login */
|
|
1389
|
+
login: string;
|
|
1390
|
+
/** Id of the object */
|
|
1391
|
+
id: number;
|
|
1392
|
+
}
|
|
1393
|
+
export declare const GetSmsUserJobRequest: S.Schema<GetSmsUserJobRequest>;
|
|
1394
|
+
export interface GetSmsUserOutgoingRequest {
|
|
1395
|
+
/** The internal name of your SMS offer */
|
|
1396
|
+
serviceName: string;
|
|
1397
|
+
/** The sms user login */
|
|
1398
|
+
login: string;
|
|
1399
|
+
/** Id of the object */
|
|
1400
|
+
id: number;
|
|
1401
|
+
}
|
|
1402
|
+
export declare const GetSmsUserOutgoingRequest: S.Schema<GetSmsUserOutgoingRequest>;
|
|
1403
|
+
export interface GetSmsUserOutgoingHlrRequest {
|
|
1404
|
+
/** The internal name of your SMS offer */
|
|
1405
|
+
serviceName: string;
|
|
1406
|
+
/** The sms user login */
|
|
1407
|
+
login: string;
|
|
1408
|
+
/** Id of the object */
|
|
1409
|
+
id: number;
|
|
1410
|
+
}
|
|
1411
|
+
export declare const GetSmsUserOutgoingHlrRequest: S.Schema<GetSmsUserOutgoingHlrRequest>;
|
|
1412
|
+
export interface GetSmsUserReceiverRequest {
|
|
1413
|
+
/** The internal name of your SMS offer */
|
|
1414
|
+
serviceName: string;
|
|
1415
|
+
/** The sms user login */
|
|
1416
|
+
login: string;
|
|
1417
|
+
/** Slot number id */
|
|
1418
|
+
slotId: number;
|
|
1419
|
+
}
|
|
1420
|
+
export declare const GetSmsUserReceiverRequest: S.Schema<GetSmsUserReceiverRequest>;
|
|
1421
|
+
export interface GetSmsUserReceiverCsvRequest {
|
|
1422
|
+
/** The internal name of your SMS offer */
|
|
1423
|
+
serviceName: string;
|
|
1424
|
+
/** The sms user login */
|
|
1425
|
+
login: string;
|
|
1426
|
+
/** Slot number id */
|
|
1427
|
+
slotId: number;
|
|
1428
|
+
}
|
|
1429
|
+
export declare const GetSmsUserReceiverCsvRequest: S.Schema<GetSmsUserReceiverCsvRequest>;
|
|
1430
|
+
export type GetSmsUserReceiverCsvResponse = string;
|
|
1431
|
+
export declare const GetSmsUserReceiverCsvResponse: S.Schema<GetSmsUserReceiverCsvResponse>;
|
|
1432
|
+
export interface GetSmsVirtualNumberRequest {
|
|
1433
|
+
/** Your virtual number */
|
|
1434
|
+
number: string;
|
|
1435
|
+
}
|
|
1436
|
+
export declare const GetSmsVirtualNumberRequest: S.Schema<GetSmsVirtualNumberRequest>;
|
|
1437
|
+
/** The ISO formated country code of the number */
|
|
1438
|
+
export type SmsVirtualNumberIsoCountryCodeEnum = "be" | "ch" | "de" | "es" | "fr" | "uk";
|
|
1439
|
+
export declare const SmsVirtualNumberIsoCountryCodeEnum: any;
|
|
1440
|
+
/** Virtual numbers */
|
|
1441
|
+
export interface SmsVirtualNumberGenericServiceWithIAM {
|
|
1442
|
+
/** The ISO formated country code of the number */
|
|
1443
|
+
countryCode?: SmsVirtualNumberIsoCountryCodeEnum;
|
|
1444
|
+
/** IAM resource metadata */
|
|
1445
|
+
iam?: IamResourceMetadata | null;
|
|
1446
|
+
/** The virtual number */
|
|
1447
|
+
number?: string;
|
|
1448
|
+
}
|
|
1449
|
+
export declare const SmsVirtualNumberGenericServiceWithIAM: S.Schema<SmsVirtualNumberGenericServiceWithIAM>;
|
|
1450
|
+
export interface GetSmsVirtualNumberByNumberRequest {
|
|
1451
|
+
/** The internal name of your SMS offer */
|
|
1452
|
+
serviceName: string;
|
|
1453
|
+
/** The virtual number */
|
|
1454
|
+
number: string;
|
|
1455
|
+
}
|
|
1456
|
+
export declare const GetSmsVirtualNumberByNumberRequest: S.Schema<GetSmsVirtualNumberByNumberRequest>;
|
|
1457
|
+
/** Virtual numbers */
|
|
1458
|
+
export interface SmsVirtualNumber {
|
|
1459
|
+
/** The ISO formated country code of the number */
|
|
1460
|
+
countryCode?: SmsVirtualNumberIsoCountryCodeEnum;
|
|
1461
|
+
/** The virtual number */
|
|
1462
|
+
number?: string;
|
|
1463
|
+
}
|
|
1464
|
+
export declare const SmsVirtualNumber: S.Schema<SmsVirtualNumber>;
|
|
1465
|
+
export interface GetSmsVirtualNumberChatAccessRequest {
|
|
1466
|
+
/** The internal name of your SMS offer */
|
|
1467
|
+
serviceName: string;
|
|
1468
|
+
/** The virtual number */
|
|
1469
|
+
number: string;
|
|
1470
|
+
}
|
|
1471
|
+
export declare const GetSmsVirtualNumberChatAccessRequest: S.Schema<GetSmsVirtualNumberChatAccessRequest>;
|
|
1472
|
+
export interface GetSmsVirtualNumberIncomingRequest {
|
|
1473
|
+
/** The internal name of your SMS offer */
|
|
1474
|
+
serviceName: string;
|
|
1475
|
+
/** The virtual number */
|
|
1476
|
+
number: string;
|
|
1477
|
+
/** Id of the object */
|
|
1478
|
+
id: number;
|
|
1479
|
+
}
|
|
1480
|
+
export declare const GetSmsVirtualNumberIncomingRequest: S.Schema<GetSmsVirtualNumberIncomingRequest>;
|
|
1481
|
+
export interface GetSmsVirtualNumberJobRequest {
|
|
1482
|
+
/** The internal name of your SMS offer */
|
|
1483
|
+
serviceName: string;
|
|
1484
|
+
/** The virtual number */
|
|
1485
|
+
number: string;
|
|
1486
|
+
/** Id of the object */
|
|
1487
|
+
id: number;
|
|
1488
|
+
}
|
|
1489
|
+
export declare const GetSmsVirtualNumberJobRequest: S.Schema<GetSmsVirtualNumberJobRequest>;
|
|
1490
|
+
/** Sms job */
|
|
1491
|
+
export interface SmsVirtualNumberJob {
|
|
1492
|
+
creationDatetime?: string;
|
|
1493
|
+
credits?: number;
|
|
1494
|
+
deliveryReceipt?: number;
|
|
1495
|
+
differedDelivery?: number;
|
|
1496
|
+
id?: number;
|
|
1497
|
+
message?: string;
|
|
1498
|
+
messageLength?: number;
|
|
1499
|
+
numberOfSms?: number;
|
|
1500
|
+
ptt?: number;
|
|
1501
|
+
receiver?: string;
|
|
1502
|
+
}
|
|
1503
|
+
export declare const SmsVirtualNumberJob: S.Schema<SmsVirtualNumberJob>;
|
|
1504
|
+
export interface GetSmsVirtualNumberOutgoingRequest {
|
|
1505
|
+
/** The internal name of your SMS offer */
|
|
1506
|
+
serviceName: string;
|
|
1507
|
+
/** The virtual number */
|
|
1508
|
+
number: string;
|
|
1509
|
+
/** Id of the object */
|
|
1510
|
+
id: number;
|
|
1511
|
+
}
|
|
1512
|
+
export declare const GetSmsVirtualNumberOutgoingRequest: S.Schema<GetSmsVirtualNumberOutgoingRequest>;
|
|
1513
|
+
export interface GetSmsVirtualNumberOutgoingHlrRequest {
|
|
1514
|
+
/** The internal name of your SMS offer */
|
|
1515
|
+
serviceName: string;
|
|
1516
|
+
/** The virtual number */
|
|
1517
|
+
number: string;
|
|
1518
|
+
/** Id of the object */
|
|
1519
|
+
id: number;
|
|
1520
|
+
}
|
|
1521
|
+
export declare const GetSmsVirtualNumberOutgoingHlrRequest: S.Schema<GetSmsVirtualNumberOutgoingHlrRequest>;
|
|
1522
|
+
export interface GetSmsVirtualNumberServiceInfosRequest {
|
|
1523
|
+
/** Your virtual number */
|
|
1524
|
+
number: string;
|
|
1525
|
+
}
|
|
1526
|
+
export declare const GetSmsVirtualNumberServiceInfosRequest: S.Schema<GetSmsVirtualNumberServiceInfosRequest>;
|
|
1527
|
+
export interface ImportSmsPhonebookRequest {
|
|
1528
|
+
/** The internal name of your SMS offer */
|
|
1529
|
+
serviceName: string;
|
|
1530
|
+
/** Identifier of the phonebook */
|
|
1531
|
+
bookKey: string;
|
|
1532
|
+
/** ID of the /me/document file you want to import */
|
|
1533
|
+
documentId: string;
|
|
1534
|
+
}
|
|
1535
|
+
export declare const ImportSmsPhonebookRequest: S.Schema<ImportSmsPhonebookRequest>;
|
|
1536
|
+
/** Operation on a telephony service */
|
|
1537
|
+
export interface TelephonyTask {
|
|
1538
|
+
/** Action associated with the task */
|
|
1539
|
+
action?: string;
|
|
1540
|
+
/** Potential failure reason of the task */
|
|
1541
|
+
message?: string | null;
|
|
1542
|
+
/** Object potentially created at the end of the task */
|
|
1543
|
+
objectCreated?: string | null;
|
|
1544
|
+
serviceType?: string;
|
|
1545
|
+
/** Status of the task */
|
|
1546
|
+
status?: TelephonyTaskStatusEnum;
|
|
1547
|
+
taskId?: number;
|
|
1548
|
+
}
|
|
1549
|
+
export declare const TelephonyTask: S.Schema<TelephonyTask>;
|
|
1550
|
+
/** Resource tag filter */
|
|
1551
|
+
export interface IamResourceTagFilterInput {
|
|
1552
|
+
}
|
|
1553
|
+
export declare const IamResourceTagFilterInput: S.Schema<IamResourceTagFilterInput>;
|
|
1554
|
+
export type ListSmsRequestIamTagsValueList = Array<IamResourceTagFilterInput>;
|
|
1555
|
+
export declare const ListSmsRequestIamTagsValueList: S.Schema<ListSmsRequestIamTagsValueList>;
|
|
1556
|
+
export type ListSmsRequestIamTagsMap = {
|
|
1557
|
+
[key: string]: ListSmsRequestIamTagsValueList | undefined;
|
|
1558
|
+
};
|
|
1559
|
+
export declare const ListSmsRequestIamTagsMap: S.Schema<ListSmsRequestIamTagsMap>;
|
|
1560
|
+
export interface ListSmsRequest {
|
|
1561
|
+
/** Filter resources on IAM tags */
|
|
1562
|
+
iamTags?: ListSmsRequestIamTagsMap;
|
|
1563
|
+
}
|
|
1564
|
+
export declare const ListSmsRequest: S.Schema<ListSmsRequest>;
|
|
1565
|
+
export type ListSmsResponseBodyList = Array<string>;
|
|
1566
|
+
export declare const ListSmsResponseBodyList: S.Schema<ListSmsResponseBodyList>;
|
|
1567
|
+
export type ListSmsResponse = ListSmsResponseBodyList;
|
|
1568
|
+
export declare const ListSmsResponse: S.Schema<ListSmsResponse>;
|
|
1569
|
+
export interface ListSmsBatchesRequest {
|
|
1570
|
+
/** The internal name of your SMS offer */
|
|
1571
|
+
serviceName: string;
|
|
1572
|
+
}
|
|
1573
|
+
export declare const ListSmsBatchesRequest: S.Schema<ListSmsBatchesRequest>;
|
|
1574
|
+
export type ListSmsBatchesResponseBodyList = Array<SmsBatch>;
|
|
1575
|
+
export declare const ListSmsBatchesResponseBodyList: S.Schema<ListSmsBatchesResponseBodyList>;
|
|
1576
|
+
export type ListSmsBatchesResponse = ListSmsBatchesResponseBodyList;
|
|
1577
|
+
export declare const ListSmsBatchesResponse: S.Schema<ListSmsBatchesResponse>;
|
|
1578
|
+
export interface ListSmsBlacklistsRequest {
|
|
1579
|
+
/** The internal name of your SMS offer */
|
|
1580
|
+
serviceName: string;
|
|
1581
|
+
/** Filter the value of batchID property (=) */
|
|
1582
|
+
batchID?: string;
|
|
1583
|
+
/** Filter the value of smsOutgoingID property (=) */
|
|
1584
|
+
smsOutgoingID?: number;
|
|
1585
|
+
}
|
|
1586
|
+
export declare const ListSmsBlacklistsRequest: S.Schema<ListSmsBlacklistsRequest>;
|
|
1587
|
+
export type ListSmsBlacklistsResponseBodyList = Array<string>;
|
|
1588
|
+
export declare const ListSmsBlacklistsResponseBodyList: S.Schema<ListSmsBlacklistsResponseBodyList>;
|
|
1589
|
+
export type ListSmsBlacklistsResponse = ListSmsBlacklistsResponseBodyList;
|
|
1590
|
+
export declare const ListSmsBlacklistsResponse: S.Schema<ListSmsBlacklistsResponse>;
|
|
1591
|
+
export interface ListSmsExceptionsRequest {
|
|
1592
|
+
/** The internal name of your SMS offer */
|
|
1593
|
+
serviceName: string;
|
|
1594
|
+
/** The receiver number to check */
|
|
1595
|
+
receiver: string;
|
|
1596
|
+
}
|
|
1597
|
+
export declare const ListSmsExceptionsRequest: S.Schema<ListSmsExceptionsRequest>;
|
|
1598
|
+
/** The exception message */
|
|
1599
|
+
export type SmsExceptionMessagesList = Array<string>;
|
|
1600
|
+
export declare const SmsExceptionMessagesList: S.Schema<SmsExceptionMessagesList>;
|
|
1601
|
+
/** Restriction type used by the operator to filter sms. */
|
|
1602
|
+
export type SmsRestrictionCodeEnum = "ALPHA" | "BAD_DLR" | "BLOCKED" | "CODING" | "DLR" | "FLASHONLY" | "MSISDN";
|
|
1603
|
+
export declare const SmsRestrictionCodeEnum: any;
|
|
1604
|
+
/** Sms reach list */
|
|
1605
|
+
export interface SmsException {
|
|
1606
|
+
/** The abreviated country code. */
|
|
1607
|
+
countrySuffixe?: string;
|
|
1608
|
+
/** The exception message */
|
|
1609
|
+
messages?: SmsExceptionMessagesList;
|
|
1610
|
+
/** The list of operators impacted. */
|
|
1611
|
+
operators?: string;
|
|
1612
|
+
/** The type of routing restriction imposed by the operator */
|
|
1613
|
+
restrictionCode?: SmsRestrictionCodeEnum;
|
|
1614
|
+
/** The substitution sender used to bypass operator filter */
|
|
1615
|
+
substitution?: string | null;
|
|
1616
|
+
}
|
|
1617
|
+
export declare const SmsException: S.Schema<SmsException>;
|
|
1618
|
+
export type ListSmsExceptionsResponseBodyList = Array<SmsException>;
|
|
1619
|
+
export declare const ListSmsExceptionsResponseBodyList: S.Schema<ListSmsExceptionsResponseBodyList>;
|
|
1620
|
+
export type ListSmsExceptionsResponse = ListSmsExceptionsResponseBodyList;
|
|
1621
|
+
export declare const ListSmsExceptionsResponse: S.Schema<ListSmsExceptionsResponse>;
|
|
1622
|
+
export interface ListSmsHlrRequest {
|
|
1623
|
+
/** The internal name of your SMS offer */
|
|
1624
|
+
serviceName: string;
|
|
1625
|
+
}
|
|
1626
|
+
export declare const ListSmsHlrRequest: S.Schema<ListSmsHlrRequest>;
|
|
1627
|
+
export type ListSmsHlrResponseBodyList = Array<number>;
|
|
1628
|
+
export declare const ListSmsHlrResponseBodyList: S.Schema<ListSmsHlrResponseBodyList>;
|
|
1629
|
+
export type ListSmsHlrResponse = ListSmsHlrResponseBodyList;
|
|
1630
|
+
export declare const ListSmsHlrResponse: S.Schema<ListSmsHlrResponse>;
|
|
1631
|
+
export interface ListSmsIncomingRequest {
|
|
1632
|
+
/** The internal name of your SMS offer */
|
|
1633
|
+
serviceName: string;
|
|
1634
|
+
/** Filter the value of creationDatetime property (>=) */
|
|
1635
|
+
creationDatetime_from?: string;
|
|
1636
|
+
/** Filter the value of creationDatetime property (<=) */
|
|
1637
|
+
creationDatetime_to?: string;
|
|
1638
|
+
/** Filter the value of sender property (=) */
|
|
1639
|
+
sender?: string;
|
|
1640
|
+
/** Filter the value of tag property (=) */
|
|
1641
|
+
tag?: string;
|
|
1642
|
+
}
|
|
1643
|
+
export declare const ListSmsIncomingRequest: S.Schema<ListSmsIncomingRequest>;
|
|
1644
|
+
export type ListSmsIncomingResponseBodyList = Array<number>;
|
|
1645
|
+
export declare const ListSmsIncomingResponseBodyList: S.Schema<ListSmsIncomingResponseBodyList>;
|
|
1646
|
+
export type ListSmsIncomingResponse = ListSmsIncomingResponseBodyList;
|
|
1647
|
+
export declare const ListSmsIncomingResponse: S.Schema<ListSmsIncomingResponse>;
|
|
1648
|
+
export interface ListSmsJobsRequest {
|
|
1649
|
+
/** The internal name of your SMS offer */
|
|
1650
|
+
serviceName: string;
|
|
1651
|
+
}
|
|
1652
|
+
export declare const ListSmsJobsRequest: S.Schema<ListSmsJobsRequest>;
|
|
1653
|
+
export type ListSmsJobsResponseBodyList = Array<number>;
|
|
1654
|
+
export declare const ListSmsJobsResponseBodyList: S.Schema<ListSmsJobsResponseBodyList>;
|
|
1655
|
+
export type ListSmsJobsResponse = ListSmsJobsResponseBodyList;
|
|
1656
|
+
export declare const ListSmsJobsResponse: S.Schema<ListSmsJobsResponse>;
|
|
1657
|
+
export interface ListSmsOutgoingRequest {
|
|
1658
|
+
/** The internal name of your SMS offer */
|
|
1659
|
+
serviceName: string;
|
|
1660
|
+
/** Filter on batch id property (=) */
|
|
1661
|
+
batchID?: string;
|
|
1662
|
+
/** Filter on creationDatetime property (>=) */
|
|
1663
|
+
creationDatetime_from?: string;
|
|
1664
|
+
/** Filter on creationDatetime property (<=) */
|
|
1665
|
+
creationDatetime_to?: string;
|
|
1666
|
+
/** Filter on deliveryReceipt property (=) */
|
|
1667
|
+
deliveryReceipt?: number;
|
|
1668
|
+
/** Filter on differedDelivery property (=) */
|
|
1669
|
+
differedDelivery?: number;
|
|
1670
|
+
/** Filter on message id property (=) */
|
|
1671
|
+
messageID?: string;
|
|
1672
|
+
/** Filter on ptt property (=) */
|
|
1673
|
+
ptt?: number;
|
|
1674
|
+
/** Filter on receiver property (=) */
|
|
1675
|
+
receiver?: string;
|
|
1676
|
+
/** Filter on sender property (=) */
|
|
1677
|
+
sender?: string;
|
|
1678
|
+
/** Filter on tag property (=) */
|
|
1679
|
+
tag?: string;
|
|
1680
|
+
}
|
|
1681
|
+
export declare const ListSmsOutgoingRequest: S.Schema<ListSmsOutgoingRequest>;
|
|
1682
|
+
export type ListSmsOutgoingResponseBodyList = Array<number>;
|
|
1683
|
+
export declare const ListSmsOutgoingResponseBodyList: S.Schema<ListSmsOutgoingResponseBodyList>;
|
|
1684
|
+
export type ListSmsOutgoingResponse = ListSmsOutgoingResponseBodyList;
|
|
1685
|
+
export declare const ListSmsOutgoingResponse: S.Schema<ListSmsOutgoingResponse>;
|
|
1686
|
+
export interface ListSmsPhonebookPhonebookContactRequest {
|
|
1687
|
+
/** The internal name of your SMS offer */
|
|
1688
|
+
serviceName: string;
|
|
1689
|
+
/** Identifier of the phonebook */
|
|
1690
|
+
bookKey: string;
|
|
1691
|
+
}
|
|
1692
|
+
export declare const ListSmsPhonebookPhonebookContactRequest: S.Schema<ListSmsPhonebookPhonebookContactRequest>;
|
|
1693
|
+
export type ListSmsPhonebookPhonebookContactResponseBodyList = Array<number>;
|
|
1694
|
+
export declare const ListSmsPhonebookPhonebookContactResponseBodyList: S.Schema<ListSmsPhonebookPhonebookContactResponseBodyList>;
|
|
1695
|
+
export type ListSmsPhonebookPhonebookContactResponse = ListSmsPhonebookPhonebookContactResponseBodyList;
|
|
1696
|
+
export declare const ListSmsPhonebookPhonebookContactResponse: S.Schema<ListSmsPhonebookPhonebookContactResponse>;
|
|
1697
|
+
export interface ListSmsPhonebooksRequest {
|
|
1698
|
+
/** The internal name of your SMS offer */
|
|
1699
|
+
serviceName: string;
|
|
1700
|
+
}
|
|
1701
|
+
export declare const ListSmsPhonebooksRequest: S.Schema<ListSmsPhonebooksRequest>;
|
|
1702
|
+
export type ListSmsPhonebooksResponseBodyList = Array<string>;
|
|
1703
|
+
export declare const ListSmsPhonebooksResponseBodyList: S.Schema<ListSmsPhonebooksResponseBodyList>;
|
|
1704
|
+
export type ListSmsPhonebooksResponse = ListSmsPhonebooksResponseBodyList;
|
|
1705
|
+
export declare const ListSmsPhonebooksResponse: S.Schema<ListSmsPhonebooksResponse>;
|
|
1706
|
+
export interface ListSmsRatePacksRequest {
|
|
1707
|
+
/** Country where you buy credits */
|
|
1708
|
+
billingCountry?: SmsBillingCountryEnum | (string & {});
|
|
1709
|
+
/** Country where you send SMS */
|
|
1710
|
+
country: SmsCountryEnum | (string & {});
|
|
1711
|
+
}
|
|
1712
|
+
export declare const ListSmsRatePacksRequest: S.Schema<ListSmsRatePacksRequest>;
|
|
1713
|
+
/** Details about a SMS pack */
|
|
1714
|
+
export interface SmsPackDetails {
|
|
1715
|
+
/** Destination country code */
|
|
1716
|
+
countryCode?: SmsCountryEnum;
|
|
1717
|
+
/** Credits consumed by sending one SMS towards the given destination */
|
|
1718
|
+
credit?: number;
|
|
1719
|
+
/** Price of one credit, including pack's promotion */
|
|
1720
|
+
creditPrice?: OrderPrice;
|
|
1721
|
+
/** Maximum quantity (excluded) of credit to order to have this price */
|
|
1722
|
+
creditQuantityMax?: number | null;
|
|
1723
|
+
/** Minimum quantity (included) of credit to order to have this price */
|
|
1724
|
+
creditQuantityMin?: number;
|
|
1725
|
+
/** Price of one credit, during a promotional event */
|
|
1726
|
+
discountCreditPrice?: OrderPrice | null;
|
|
1727
|
+
/** Percentage applied as part of a promotional event */
|
|
1728
|
+
discountPercentage?: number | null;
|
|
1729
|
+
/** Price of one SMS, during a promotional event */
|
|
1730
|
+
discountSmsPrice?: OrderPrice | null;
|
|
1731
|
+
/** Price of one SMS sent towards the given destination, including pack's promotion */
|
|
1732
|
+
smsPrice?: OrderPrice;
|
|
1733
|
+
/** Maximum quantity (excluded) of SMS you can obtain with this pack */
|
|
1734
|
+
smsQuantityMax?: number | null;
|
|
1735
|
+
/** Minimum quantity (included) of SMS you can obtain with this pack */
|
|
1736
|
+
smsQuantityMin?: number;
|
|
1737
|
+
}
|
|
1738
|
+
export declare const SmsPackDetails: S.Schema<SmsPackDetails>;
|
|
1739
|
+
export type ListSmsRatePacksResponseBodyList = Array<SmsPackDetails>;
|
|
1740
|
+
export declare const ListSmsRatePacksResponseBodyList: S.Schema<ListSmsRatePacksResponseBodyList>;
|
|
1741
|
+
export type ListSmsRatePacksResponse = ListSmsRatePacksResponseBodyList;
|
|
1742
|
+
export declare const ListSmsRatePacksResponse: S.Schema<ListSmsRatePacksResponse>;
|
|
1743
|
+
export interface ListSmsReceiversRequest {
|
|
1744
|
+
/** The internal name of your SMS offer */
|
|
1745
|
+
serviceName: string;
|
|
1746
|
+
}
|
|
1747
|
+
export declare const ListSmsReceiversRequest: S.Schema<ListSmsReceiversRequest>;
|
|
1748
|
+
export type ListSmsReceiversResponseBodyList = Array<number>;
|
|
1749
|
+
export declare const ListSmsReceiversResponseBodyList: S.Schema<ListSmsReceiversResponseBodyList>;
|
|
1750
|
+
export type ListSmsReceiversResponse = ListSmsReceiversResponseBodyList;
|
|
1751
|
+
export declare const ListSmsReceiversResponse: S.Schema<ListSmsReceiversResponse>;
|
|
1752
|
+
/** All country prices accessible from a reference */
|
|
1753
|
+
export type ReferenceCountryEnum = "all" | "ca" | "cz" | "de" | "en" | "es" | "fi" | "fr" | "gb" | "ie" | "it" | "lt" | "ma" | "nl" | "pl" | "pp" | "pt" | "qc" | "ru" | "sk" | "sn" | "tn" | "we";
|
|
1754
|
+
export declare const ReferenceCountryEnum: any;
|
|
1755
|
+
/** Pack quantity levels */
|
|
1756
|
+
export type SmsPackQuantityEnum = 100 | 200 | 250 | 500 | 1000 | 2500 | 5000 | 10000 | 25000 | 50000 | 100000 | 1000000;
|
|
1757
|
+
export declare const SmsPackQuantityEnum: any;
|
|
1758
|
+
export interface ListSmsSeeOffersRequest {
|
|
1759
|
+
/** The internal name of your SMS offer */
|
|
1760
|
+
serviceName: string;
|
|
1761
|
+
/** Filter to have the currency country prices */
|
|
1762
|
+
countryCurrencyPrice: ReferenceCountryEnum | (string & {});
|
|
1763
|
+
/** Filter to have the country destination */
|
|
1764
|
+
countryDestination: SmsCountryEnum | (string & {});
|
|
1765
|
+
/** Sms pack offer quantity */
|
|
1766
|
+
quantity: SmsPackQuantityEnum | (number & {});
|
|
1767
|
+
}
|
|
1768
|
+
export declare const ListSmsSeeOffersRequest: S.Schema<ListSmsSeeOffersRequest>;
|
|
1769
|
+
/** A structure describing all information about an sms pack offer */
|
|
1770
|
+
export interface SmsPackOffer {
|
|
1771
|
+
countryDestination?: string;
|
|
1772
|
+
giftPrice?: number | null;
|
|
1773
|
+
giftQuantity?: number | null;
|
|
1774
|
+
language?: string;
|
|
1775
|
+
price?: number;
|
|
1776
|
+
quantity?: number;
|
|
1777
|
+
smsQuantity?: number;
|
|
1778
|
+
totalPrice?: number | null;
|
|
1779
|
+
}
|
|
1780
|
+
export declare const SmsPackOffer: S.Schema<SmsPackOffer>;
|
|
1781
|
+
export type ListSmsSeeOffersResponseBodyList = Array<SmsPackOffer>;
|
|
1782
|
+
export declare const ListSmsSeeOffersResponseBodyList: S.Schema<ListSmsSeeOffersResponseBodyList>;
|
|
1783
|
+
export type ListSmsSeeOffersResponse = ListSmsSeeOffersResponseBodyList;
|
|
1784
|
+
export declare const ListSmsSeeOffersResponse: S.Schema<ListSmsSeeOffersResponse>;
|
|
1785
|
+
export interface ListSmsSenderDocumentsRequest {
|
|
1786
|
+
/** The internal name of your SMS offer */
|
|
1787
|
+
serviceName: string;
|
|
1788
|
+
/** The sms sender */
|
|
1789
|
+
sender: string;
|
|
1790
|
+
}
|
|
1791
|
+
export declare const ListSmsSenderDocumentsRequest: S.Schema<ListSmsSenderDocumentsRequest>;
|
|
1792
|
+
export type ListSmsSenderDocumentsResponseBodyList = Array<string>;
|
|
1793
|
+
export declare const ListSmsSenderDocumentsResponseBodyList: S.Schema<ListSmsSenderDocumentsResponseBodyList>;
|
|
1794
|
+
export type ListSmsSenderDocumentsResponse = ListSmsSenderDocumentsResponseBodyList;
|
|
1795
|
+
export declare const ListSmsSenderDocumentsResponse: S.Schema<ListSmsSenderDocumentsResponse>;
|
|
1796
|
+
export interface ListSmsSendersRequest {
|
|
1797
|
+
/** The internal name of your SMS offer */
|
|
1798
|
+
serviceName: string;
|
|
1799
|
+
}
|
|
1800
|
+
export declare const ListSmsSendersRequest: S.Schema<ListSmsSendersRequest>;
|
|
1801
|
+
export type ListSmsSendersResponseBodyList = Array<string>;
|
|
1802
|
+
export declare const ListSmsSendersResponseBodyList: S.Schema<ListSmsSendersResponseBodyList>;
|
|
1803
|
+
export type ListSmsSendersResponse = ListSmsSendersResponseBodyList;
|
|
1804
|
+
export declare const ListSmsSendersResponse: S.Schema<ListSmsSendersResponse>;
|
|
1805
|
+
/** The referer of the available sender */
|
|
1806
|
+
export type SmsSenderRefererEnum = "domain" | "nichandle";
|
|
1807
|
+
export declare const SmsSenderRefererEnum: any;
|
|
1808
|
+
export interface ListSmsSendersAvailableForValidationRequest {
|
|
1809
|
+
/** The internal name of your SMS offer */
|
|
1810
|
+
serviceName: string;
|
|
1811
|
+
/** Information type */
|
|
1812
|
+
referer?: SmsSenderRefererEnum | (string & {});
|
|
1813
|
+
}
|
|
1814
|
+
export declare const ListSmsSendersAvailableForValidationRequest: S.Schema<ListSmsSendersAvailableForValidationRequest>;
|
|
1815
|
+
/** A structure describing all information about senders available */
|
|
1816
|
+
export interface SmsSenderAvailable {
|
|
1817
|
+
referer?: SmsSenderRefererEnum;
|
|
1818
|
+
sender?: string;
|
|
1819
|
+
}
|
|
1820
|
+
export declare const SmsSenderAvailable: S.Schema<SmsSenderAvailable>;
|
|
1821
|
+
export type ListSmsSendersAvailableForValidationResponseBodyList = Array<SmsSenderAvailable>;
|
|
1822
|
+
export declare const ListSmsSendersAvailableForValidationResponseBodyList: S.Schema<ListSmsSendersAvailableForValidationResponseBodyList>;
|
|
1823
|
+
export type ListSmsSendersAvailableForValidationResponse = ListSmsSendersAvailableForValidationResponseBodyList;
|
|
1824
|
+
export declare const ListSmsSendersAvailableForValidationResponse: S.Schema<ListSmsSendersAvailableForValidationResponse>;
|
|
1825
|
+
export interface ListSmsSmppAllowedIPsRequest {
|
|
1826
|
+
/** The internal name of your SMS offer */
|
|
1827
|
+
serviceName: string;
|
|
1828
|
+
}
|
|
1829
|
+
export declare const ListSmsSmppAllowedIPsRequest: S.Schema<ListSmsSmppAllowedIPsRequest>;
|
|
1830
|
+
export type ListSmsSmppAllowedIPsResponseBodyList = Array<string>;
|
|
1831
|
+
export declare const ListSmsSmppAllowedIPsResponseBodyList: S.Schema<ListSmsSmppAllowedIPsResponseBodyList>;
|
|
1832
|
+
export type ListSmsSmppAllowedIPsResponse = ListSmsSmppAllowedIPsResponseBodyList;
|
|
1833
|
+
export declare const ListSmsSmppAllowedIPsResponse: S.Schema<ListSmsSmppAllowedIPsResponse>;
|
|
1834
|
+
export interface ListSmsTaskRequest {
|
|
1835
|
+
/** The internal name of your SMS offer */
|
|
1836
|
+
serviceName: string;
|
|
1837
|
+
/** Filter the value of status property (=) */
|
|
1838
|
+
status?: TelephonyTaskStatusEnum | (string & {});
|
|
1839
|
+
}
|
|
1840
|
+
export declare const ListSmsTaskRequest: S.Schema<ListSmsTaskRequest>;
|
|
1841
|
+
export type ListSmsTaskResponseBodyList = Array<number>;
|
|
1842
|
+
export declare const ListSmsTaskResponseBodyList: S.Schema<ListSmsTaskResponseBodyList>;
|
|
1843
|
+
export type ListSmsTaskResponse = ListSmsTaskResponseBodyList;
|
|
1844
|
+
export declare const ListSmsTaskResponse: S.Schema<ListSmsTaskResponse>;
|
|
1845
|
+
export interface ListSmsTemplatesControlRequest {
|
|
1846
|
+
/** The internal name of your SMS offer */
|
|
1847
|
+
serviceName: string;
|
|
1848
|
+
}
|
|
1849
|
+
export declare const ListSmsTemplatesControlRequest: S.Schema<ListSmsTemplatesControlRequest>;
|
|
1850
|
+
export type ListSmsTemplatesControlResponseBodyList = Array<string>;
|
|
1851
|
+
export declare const ListSmsTemplatesControlResponseBodyList: S.Schema<ListSmsTemplatesControlResponseBodyList>;
|
|
1852
|
+
export type ListSmsTemplatesControlResponse = ListSmsTemplatesControlResponseBodyList;
|
|
1853
|
+
export declare const ListSmsTemplatesControlResponse: S.Schema<ListSmsTemplatesControlResponse>;
|
|
1854
|
+
export interface ListSmsUserIncomingRequest {
|
|
1855
|
+
/** The internal name of your SMS offer */
|
|
1856
|
+
serviceName: string;
|
|
1857
|
+
/** The sms user login */
|
|
1858
|
+
login: string;
|
|
1859
|
+
/** Filter the value of sender property (=) */
|
|
1860
|
+
sender?: string;
|
|
1861
|
+
/** Filter the value of tag property (=) */
|
|
1862
|
+
tag?: string;
|
|
1863
|
+
}
|
|
1864
|
+
export declare const ListSmsUserIncomingRequest: S.Schema<ListSmsUserIncomingRequest>;
|
|
1865
|
+
export type ListSmsUserIncomingResponseBodyList = Array<number>;
|
|
1866
|
+
export declare const ListSmsUserIncomingResponseBodyList: S.Schema<ListSmsUserIncomingResponseBodyList>;
|
|
1867
|
+
export type ListSmsUserIncomingResponse = ListSmsUserIncomingResponseBodyList;
|
|
1868
|
+
export declare const ListSmsUserIncomingResponse: S.Schema<ListSmsUserIncomingResponse>;
|
|
1869
|
+
export interface ListSmsUserJobsRequest {
|
|
1870
|
+
/** The internal name of your SMS offer */
|
|
1871
|
+
serviceName: string;
|
|
1872
|
+
/** The sms user login */
|
|
1873
|
+
login: string;
|
|
1874
|
+
}
|
|
1875
|
+
export declare const ListSmsUserJobsRequest: S.Schema<ListSmsUserJobsRequest>;
|
|
1876
|
+
export type ListSmsUserJobsResponseBodyList = Array<number>;
|
|
1877
|
+
export declare const ListSmsUserJobsResponseBodyList: S.Schema<ListSmsUserJobsResponseBodyList>;
|
|
1878
|
+
export type ListSmsUserJobsResponse = ListSmsUserJobsResponseBodyList;
|
|
1879
|
+
export declare const ListSmsUserJobsResponse: S.Schema<ListSmsUserJobsResponse>;
|
|
1880
|
+
export interface ListSmsUserOutgoingRequest {
|
|
1881
|
+
/** The internal name of your SMS offer */
|
|
1882
|
+
serviceName: string;
|
|
1883
|
+
/** The sms user login */
|
|
1884
|
+
login: string;
|
|
1885
|
+
/** Filter the value of deliveryReceipt property (=) */
|
|
1886
|
+
deliveryReceipt?: number;
|
|
1887
|
+
/** Filter the value of differedDelivery property (=) */
|
|
1888
|
+
differedDelivery?: number;
|
|
1889
|
+
/** Filter the value of ptt property (=) */
|
|
1890
|
+
ptt?: number;
|
|
1891
|
+
/** Filter the value of receiver property (=) */
|
|
1892
|
+
receiver?: string;
|
|
1893
|
+
/** Filter the value of sender property (=) */
|
|
1894
|
+
sender?: string;
|
|
1895
|
+
/** Filter the value of tag property (=) */
|
|
1896
|
+
tag?: string;
|
|
1897
|
+
}
|
|
1898
|
+
export declare const ListSmsUserOutgoingRequest: S.Schema<ListSmsUserOutgoingRequest>;
|
|
1899
|
+
export type ListSmsUserOutgoingResponseBodyList = Array<number>;
|
|
1900
|
+
export declare const ListSmsUserOutgoingResponseBodyList: S.Schema<ListSmsUserOutgoingResponseBodyList>;
|
|
1901
|
+
export type ListSmsUserOutgoingResponse = ListSmsUserOutgoingResponseBodyList;
|
|
1902
|
+
export declare const ListSmsUserOutgoingResponse: S.Schema<ListSmsUserOutgoingResponse>;
|
|
1903
|
+
export interface ListSmsUserReceiversRequest {
|
|
1904
|
+
/** The internal name of your SMS offer */
|
|
1905
|
+
serviceName: string;
|
|
1906
|
+
/** The sms user login */
|
|
1907
|
+
login: string;
|
|
1908
|
+
}
|
|
1909
|
+
export declare const ListSmsUserReceiversRequest: S.Schema<ListSmsUserReceiversRequest>;
|
|
1910
|
+
export type ListSmsUserReceiversResponseBodyList = Array<number>;
|
|
1911
|
+
export declare const ListSmsUserReceiversResponseBodyList: S.Schema<ListSmsUserReceiversResponseBodyList>;
|
|
1912
|
+
export type ListSmsUserReceiversResponse = ListSmsUserReceiversResponseBodyList;
|
|
1913
|
+
export declare const ListSmsUserReceiversResponse: S.Schema<ListSmsUserReceiversResponse>;
|
|
1914
|
+
export interface ListSmsUsersRequest {
|
|
1915
|
+
/** The internal name of your SMS offer */
|
|
1916
|
+
serviceName: string;
|
|
1917
|
+
}
|
|
1918
|
+
export declare const ListSmsUsersRequest: S.Schema<ListSmsUsersRequest>;
|
|
1919
|
+
export type ListSmsUsersResponseBodyList = Array<string>;
|
|
1920
|
+
export declare const ListSmsUsersResponseBodyList: S.Schema<ListSmsUsersResponseBodyList>;
|
|
1921
|
+
export type ListSmsUsersResponse = ListSmsUsersResponseBodyList;
|
|
1922
|
+
export declare const ListSmsUsersResponse: S.Schema<ListSmsUsersResponse>;
|
|
1923
|
+
export interface ListSmsVirtualNumberIncomingRequest {
|
|
1924
|
+
/** The internal name of your SMS offer */
|
|
1925
|
+
serviceName: string;
|
|
1926
|
+
/** The virtual number */
|
|
1927
|
+
number: string;
|
|
1928
|
+
/** Filter the value of creationDatetime property (>=) */
|
|
1929
|
+
creationDatetime_from?: string;
|
|
1930
|
+
/** Filter the value of creationDatetime property (<=) */
|
|
1931
|
+
creationDatetime_to?: string;
|
|
1932
|
+
/** Filter the value of sender property (=) */
|
|
1933
|
+
sender?: string;
|
|
1934
|
+
/** Filter the value of tag property (=) */
|
|
1935
|
+
tag?: string;
|
|
1936
|
+
}
|
|
1937
|
+
export declare const ListSmsVirtualNumberIncomingRequest: S.Schema<ListSmsVirtualNumberIncomingRequest>;
|
|
1938
|
+
export type ListSmsVirtualNumberIncomingResponseBodyList = Array<number>;
|
|
1939
|
+
export declare const ListSmsVirtualNumberIncomingResponseBodyList: S.Schema<ListSmsVirtualNumberIncomingResponseBodyList>;
|
|
1940
|
+
export type ListSmsVirtualNumberIncomingResponse = ListSmsVirtualNumberIncomingResponseBodyList;
|
|
1941
|
+
export declare const ListSmsVirtualNumberIncomingResponse: S.Schema<ListSmsVirtualNumberIncomingResponse>;
|
|
1942
|
+
export interface ListSmsVirtualNumberJobsRequest {
|
|
1943
|
+
/** The internal name of your SMS offer */
|
|
1944
|
+
serviceName: string;
|
|
1945
|
+
/** The virtual number */
|
|
1946
|
+
number: string;
|
|
1947
|
+
}
|
|
1948
|
+
export declare const ListSmsVirtualNumberJobsRequest: S.Schema<ListSmsVirtualNumberJobsRequest>;
|
|
1949
|
+
export type ListSmsVirtualNumberJobsResponseBodyList = Array<number>;
|
|
1950
|
+
export declare const ListSmsVirtualNumberJobsResponseBodyList: S.Schema<ListSmsVirtualNumberJobsResponseBodyList>;
|
|
1951
|
+
export type ListSmsVirtualNumberJobsResponse = ListSmsVirtualNumberJobsResponseBodyList;
|
|
1952
|
+
export declare const ListSmsVirtualNumberJobsResponse: S.Schema<ListSmsVirtualNumberJobsResponse>;
|
|
1953
|
+
export interface ListSmsVirtualNumberOutgoingRequest {
|
|
1954
|
+
/** The internal name of your SMS offer */
|
|
1955
|
+
serviceName: string;
|
|
1956
|
+
/** The virtual number */
|
|
1957
|
+
number: string;
|
|
1958
|
+
/** Filter the value of creationDatetime property (>=) */
|
|
1959
|
+
creationDatetime_from?: string;
|
|
1960
|
+
/** Filter the value of creationDatetime property (<=) */
|
|
1961
|
+
creationDatetime_to?: string;
|
|
1962
|
+
/** Filter the value of deliveryReceipt property (=) */
|
|
1963
|
+
deliveryReceipt?: number;
|
|
1964
|
+
/** Filter the value of differedDelivery property (=) */
|
|
1965
|
+
differedDelivery?: number;
|
|
1966
|
+
/** Filter the value of ptt property (=) */
|
|
1967
|
+
ptt?: number;
|
|
1968
|
+
/** Filter the value of receiver property (=) */
|
|
1969
|
+
receiver?: string;
|
|
1970
|
+
/** Filter the value of sender property (=) */
|
|
1971
|
+
sender?: string;
|
|
1972
|
+
/** Filter the value of tag property (=) */
|
|
1973
|
+
tag?: string;
|
|
1974
|
+
}
|
|
1975
|
+
export declare const ListSmsVirtualNumberOutgoingRequest: S.Schema<ListSmsVirtualNumberOutgoingRequest>;
|
|
1976
|
+
export type ListSmsVirtualNumberOutgoingResponseBodyList = Array<number>;
|
|
1977
|
+
export declare const ListSmsVirtualNumberOutgoingResponseBodyList: S.Schema<ListSmsVirtualNumberOutgoingResponseBodyList>;
|
|
1978
|
+
export type ListSmsVirtualNumberOutgoingResponse = ListSmsVirtualNumberOutgoingResponseBodyList;
|
|
1979
|
+
export declare const ListSmsVirtualNumberOutgoingResponse: S.Schema<ListSmsVirtualNumberOutgoingResponse>;
|
|
1980
|
+
export type ListSmsVirtualNumbersRequestIamTagsValueList = Array<IamResourceTagFilterInput>;
|
|
1981
|
+
export declare const ListSmsVirtualNumbersRequestIamTagsValueList: S.Schema<ListSmsVirtualNumbersRequestIamTagsValueList>;
|
|
1982
|
+
export type ListSmsVirtualNumbersRequestIamTagsMap = {
|
|
1983
|
+
[key: string]: ListSmsVirtualNumbersRequestIamTagsValueList | undefined;
|
|
1984
|
+
};
|
|
1985
|
+
export declare const ListSmsVirtualNumbersRequestIamTagsMap: S.Schema<ListSmsVirtualNumbersRequestIamTagsMap>;
|
|
1986
|
+
export interface ListSmsVirtualNumbersRequest {
|
|
1987
|
+
/** Filter resources on IAM tags */
|
|
1988
|
+
iamTags?: ListSmsVirtualNumbersRequestIamTagsMap;
|
|
1989
|
+
}
|
|
1990
|
+
export declare const ListSmsVirtualNumbersRequest: S.Schema<ListSmsVirtualNumbersRequest>;
|
|
1991
|
+
export type ListSmsVirtualNumbersResponseBodyList = Array<string>;
|
|
1992
|
+
export declare const ListSmsVirtualNumbersResponseBodyList: S.Schema<ListSmsVirtualNumbersResponseBodyList>;
|
|
1993
|
+
export type ListSmsVirtualNumbersResponse = ListSmsVirtualNumbersResponseBodyList;
|
|
1994
|
+
export declare const ListSmsVirtualNumbersResponse: S.Schema<ListSmsVirtualNumbersResponse>;
|
|
1995
|
+
export interface ListSmsVirtualNumbersRequest2 {
|
|
1996
|
+
/** The internal name of your SMS offer */
|
|
1997
|
+
serviceName: string;
|
|
1998
|
+
}
|
|
1999
|
+
export declare const ListSmsVirtualNumbersRequest2: S.Schema<ListSmsVirtualNumbersRequest2>;
|
|
2000
|
+
export type ListSmsVirtualNumbersResponseBodyList2 = Array<string>;
|
|
2001
|
+
export declare const ListSmsVirtualNumbersResponseBodyList2: S.Schema<ListSmsVirtualNumbersResponseBodyList2>;
|
|
2002
|
+
export type ListSmsVirtualNumbersResponse2 = ListSmsVirtualNumbersResponseBodyList2;
|
|
2003
|
+
export declare const ListSmsVirtualNumbersResponse2: S.Schema<ListSmsVirtualNumbersResponse2>;
|
|
2004
|
+
export interface PutSmsRequest {
|
|
2005
|
+
/** The internal name of your SMS offer */
|
|
2006
|
+
serviceName: string;
|
|
2007
|
+
automaticRecreditAmount?: SmsPackQuantityAutomaticRecreditEnum | (number & {}) | null;
|
|
2008
|
+
/** URL called when state of a sent SMS changes */
|
|
2009
|
+
callBack?: string | null;
|
|
2010
|
+
/** Credit threshold after which an automatic recredit is launched */
|
|
2011
|
+
creditThresholdForAutomaticRecredit?: number;
|
|
2012
|
+
description?: string;
|
|
2013
|
+
smsResponse?: SmsResponse;
|
|
2014
|
+
/** URL called when a STOP is received after a receiver replied stop to a SMS */
|
|
2015
|
+
stopCallBack?: string | null;
|
|
2016
|
+
templates?: SmsTemplates;
|
|
2017
|
+
}
|
|
2018
|
+
export declare const PutSmsRequest: S.Schema<PutSmsRequest>;
|
|
2019
|
+
export interface PutSmsResponse {
|
|
2020
|
+
}
|
|
2021
|
+
export declare const PutSmsResponse: S.Schema<PutSmsResponse>;
|
|
2022
|
+
export interface PutSmsBatchRequest {
|
|
2023
|
+
/** The internal name of your SMS offer */
|
|
2024
|
+
serviceName: string;
|
|
2025
|
+
/** Id */
|
|
2026
|
+
id: string;
|
|
2027
|
+
/** Batch name */
|
|
2028
|
+
name: string;
|
|
2029
|
+
}
|
|
2030
|
+
export declare const PutSmsBatchRequest: S.Schema<PutSmsBatchRequest>;
|
|
2031
|
+
export interface PutSmsPhonebookRequest {
|
|
2032
|
+
/** The internal name of your SMS offer */
|
|
2033
|
+
serviceName: string;
|
|
2034
|
+
/** Identifier of the phonebook */
|
|
2035
|
+
bookKey: string;
|
|
2036
|
+
/** Phonebook name */
|
|
2037
|
+
name?: string;
|
|
2038
|
+
}
|
|
2039
|
+
export declare const PutSmsPhonebookRequest: S.Schema<PutSmsPhonebookRequest>;
|
|
2040
|
+
export interface PutSmsPhonebookResponse {
|
|
2041
|
+
}
|
|
2042
|
+
export declare const PutSmsPhonebookResponse: S.Schema<PutSmsPhonebookResponse>;
|
|
2043
|
+
export interface PutSmsPhonebookPhonebookContactRequest {
|
|
2044
|
+
/** The internal name of your SMS offer */
|
|
2045
|
+
serviceName: string;
|
|
2046
|
+
/** Identifier of the phonebook */
|
|
2047
|
+
bookKey: string;
|
|
2048
|
+
/** Contact identifier */
|
|
2049
|
+
id: number;
|
|
2050
|
+
/** Group name of the phonebook */
|
|
2051
|
+
group?: string;
|
|
2052
|
+
/** Home mobile phone number of the contact */
|
|
2053
|
+
homeMobile?: string | null;
|
|
2054
|
+
/** Home landline phone number of the contact */
|
|
2055
|
+
homePhone?: string | null;
|
|
2056
|
+
/** Contact name */
|
|
2057
|
+
name?: string;
|
|
2058
|
+
/** Contact surname */
|
|
2059
|
+
surname?: string;
|
|
2060
|
+
/** Mobile phone office number of the contact */
|
|
2061
|
+
workMobile?: string | null;
|
|
2062
|
+
/** Landline phone office number of the contact */
|
|
2063
|
+
workPhone?: string | null;
|
|
2064
|
+
}
|
|
2065
|
+
export declare const PutSmsPhonebookPhonebookContactRequest: S.Schema<PutSmsPhonebookPhonebookContactRequest>;
|
|
2066
|
+
export interface PutSmsPhonebookPhonebookContactResponse {
|
|
2067
|
+
}
|
|
2068
|
+
export declare const PutSmsPhonebookPhonebookContactResponse: S.Schema<PutSmsPhonebookPhonebookContactResponse>;
|
|
2069
|
+
export interface PutSmsReceiverRequest {
|
|
2070
|
+
/** The internal name of your SMS offer */
|
|
2071
|
+
serviceName: string;
|
|
2072
|
+
/** Slot number id */
|
|
2073
|
+
slotId: number;
|
|
2074
|
+
/** Download file from URL before sending to contacts (works only with csvUrl and not document ID) */
|
|
2075
|
+
autoUpdate?: boolean;
|
|
2076
|
+
/** Description name of the document */
|
|
2077
|
+
description?: string;
|
|
2078
|
+
}
|
|
2079
|
+
export declare const PutSmsReceiverRequest: S.Schema<PutSmsReceiverRequest>;
|
|
2080
|
+
export interface PutSmsReceiverResponse {
|
|
2081
|
+
}
|
|
2082
|
+
export declare const PutSmsReceiverResponse: S.Schema<PutSmsReceiverResponse>;
|
|
2083
|
+
export interface PutSmsSenderRequest {
|
|
2084
|
+
/** The internal name of your SMS offer */
|
|
2085
|
+
serviceName: string;
|
|
2086
|
+
/** The sms sender */
|
|
2087
|
+
sender: string;
|
|
2088
|
+
/** Sender description */
|
|
2089
|
+
description?: string;
|
|
2090
|
+
/** Sender status */
|
|
2091
|
+
status?: SmsStatusSenderEnum | (string & {});
|
|
2092
|
+
}
|
|
2093
|
+
export declare const PutSmsSenderRequest: S.Schema<PutSmsSenderRequest>;
|
|
2094
|
+
export interface PutSmsSenderResponse {
|
|
2095
|
+
}
|
|
2096
|
+
export declare const PutSmsSenderResponse: S.Schema<PutSmsSenderResponse>;
|
|
2097
|
+
export interface PutSmsSenderDocumentRequest {
|
|
2098
|
+
/** The internal name of your SMS offer */
|
|
2099
|
+
serviceName: string;
|
|
2100
|
+
/** The sms sender */
|
|
2101
|
+
sender: string;
|
|
2102
|
+
/** Document ID */
|
|
2103
|
+
documentID: string;
|
|
2104
|
+
/** Document description */
|
|
2105
|
+
description?: string | null;
|
|
2106
|
+
/** Document name */
|
|
2107
|
+
name?: string;
|
|
2108
|
+
}
|
|
2109
|
+
export declare const PutSmsSenderDocumentRequest: S.Schema<PutSmsSenderDocumentRequest>;
|
|
2110
|
+
export interface PutSmsSenderDocumentResponse {
|
|
2111
|
+
}
|
|
2112
|
+
export declare const PutSmsSenderDocumentResponse: S.Schema<PutSmsSenderDocumentResponse>;
|
|
2113
|
+
export interface PutSmsServiceInfosRequest {
|
|
2114
|
+
/** The internal name of your SMS offer */
|
|
2115
|
+
serviceName: string;
|
|
2116
|
+
/** Way of handling the renew */
|
|
2117
|
+
renew?: ServiceRenewType | null;
|
|
2118
|
+
}
|
|
2119
|
+
export declare const PutSmsServiceInfosRequest: S.Schema<PutSmsServiceInfosRequest>;
|
|
2120
|
+
export interface PutSmsServiceInfosResponse {
|
|
2121
|
+
}
|
|
2122
|
+
export declare const PutSmsServiceInfosResponse: S.Schema<PutSmsServiceInfosResponse>;
|
|
2123
|
+
/** Smpp allowed IPs action */
|
|
2124
|
+
export type SmsAllowedIPsActionEnum = "add" | "remove";
|
|
2125
|
+
export declare const SmsAllowedIPsActionEnum: any;
|
|
2126
|
+
/** List of IPs to add or remove */
|
|
2127
|
+
export type PutSmsSmppAllowedIPsRequestIpsList = Array<string>;
|
|
2128
|
+
export declare const PutSmsSmppAllowedIPsRequestIpsList: S.Schema<PutSmsSmppAllowedIPsRequestIpsList>;
|
|
2129
|
+
export interface PutSmsSmppAllowedIPsRequest {
|
|
2130
|
+
/** The internal name of your SMS offer */
|
|
2131
|
+
serviceName: string;
|
|
2132
|
+
/** Action to perform on the provided IPs */
|
|
2133
|
+
action: SmsAllowedIPsActionEnum | (string & {});
|
|
2134
|
+
/** List of IPs to add or remove */
|
|
2135
|
+
ips: PutSmsSmppAllowedIPsRequestIpsList;
|
|
2136
|
+
}
|
|
2137
|
+
export declare const PutSmsSmppAllowedIPsRequest: S.Schema<PutSmsSmppAllowedIPsRequest>;
|
|
2138
|
+
export type PutSmsSmppAllowedIPsResponseBodyList = Array<string>;
|
|
2139
|
+
export declare const PutSmsSmppAllowedIPsResponseBodyList: S.Schema<PutSmsSmppAllowedIPsResponseBodyList>;
|
|
2140
|
+
export type PutSmsSmppAllowedIPsResponse = PutSmsSmppAllowedIPsResponseBodyList;
|
|
2141
|
+
export declare const PutSmsSmppAllowedIPsResponse: S.Schema<PutSmsSmppAllowedIPsResponse>;
|
|
2142
|
+
export interface PutSmsTemplatesControlRequest {
|
|
2143
|
+
/** The internal name of your SMS offer */
|
|
2144
|
+
serviceName: string;
|
|
2145
|
+
/** Name of the template */
|
|
2146
|
+
name: string;
|
|
2147
|
+
/** Specify the kind of template */
|
|
2148
|
+
activity?: SmsTypeTemplateEnum | (string & {});
|
|
2149
|
+
/** Template description */
|
|
2150
|
+
description?: string;
|
|
2151
|
+
/** Message pattern to be moderated. Use "#VALUE#" format for dynamic text area. */
|
|
2152
|
+
message?: string;
|
|
2153
|
+
/** Template status */
|
|
2154
|
+
status?: SmsStatusSenderEnum | (string & {});
|
|
2155
|
+
}
|
|
2156
|
+
export declare const PutSmsTemplatesControlRequest: S.Schema<PutSmsTemplatesControlRequest>;
|
|
2157
|
+
export interface PutSmsTemplatesControlResponse {
|
|
2158
|
+
}
|
|
2159
|
+
export declare const PutSmsTemplatesControlResponse: S.Schema<PutSmsTemplatesControlResponse>;
|
|
2160
|
+
export type PutSmsUserRequestIpRestrictionsList = Array<string>;
|
|
2161
|
+
export declare const PutSmsUserRequestIpRestrictionsList: S.Schema<PutSmsUserRequestIpRestrictionsList>;
|
|
2162
|
+
export interface PutSmsUserRequest {
|
|
2163
|
+
/** The internal name of your SMS offer */
|
|
2164
|
+
serviceName: string;
|
|
2165
|
+
/** The sms user login */
|
|
2166
|
+
login: string;
|
|
2167
|
+
alertThresholdInformations?: SmsAlertThreshold;
|
|
2168
|
+
/** URL called when state of a sent SMS changes */
|
|
2169
|
+
callBack?: string | null;
|
|
2170
|
+
ipRestrictions?: PutSmsUserRequestIpRestrictionsList;
|
|
2171
|
+
password?: string | Redacted.Redacted<string>;
|
|
2172
|
+
quotaInformations?: SmsQuota;
|
|
2173
|
+
/** URL called when a STOP is received after a receiver replied stop to a SMS */
|
|
2174
|
+
stopCallBack?: string | null;
|
|
2175
|
+
}
|
|
2176
|
+
export declare const PutSmsUserRequest: S.Schema<PutSmsUserRequest>;
|
|
2177
|
+
export interface PutSmsUserResponse {
|
|
2178
|
+
}
|
|
2179
|
+
export declare const PutSmsUserResponse: S.Schema<PutSmsUserResponse>;
|
|
2180
|
+
export interface PutSmsUserReceiverRequest {
|
|
2181
|
+
/** The internal name of your SMS offer */
|
|
2182
|
+
serviceName: string;
|
|
2183
|
+
/** The sms user login */
|
|
2184
|
+
login: string;
|
|
2185
|
+
/** Slot number id */
|
|
2186
|
+
slotId: number;
|
|
2187
|
+
/** Download file from URL before sending to contacts (works only with csvUrl and not document ID) */
|
|
2188
|
+
autoUpdate?: boolean;
|
|
2189
|
+
/** Description name of the document */
|
|
2190
|
+
description?: string;
|
|
2191
|
+
}
|
|
2192
|
+
export declare const PutSmsUserReceiverRequest: S.Schema<PutSmsUserReceiverRequest>;
|
|
2193
|
+
export interface PutSmsUserReceiverResponse {
|
|
2194
|
+
}
|
|
2195
|
+
export declare const PutSmsUserReceiverResponse: S.Schema<PutSmsUserReceiverResponse>;
|
|
2196
|
+
export interface PutSmsVirtualNumberServiceInfosRequest {
|
|
2197
|
+
/** Your virtual number */
|
|
2198
|
+
number: string;
|
|
2199
|
+
/** Way of handling the renew */
|
|
2200
|
+
renew?: ServiceRenewType | null;
|
|
2201
|
+
}
|
|
2202
|
+
export declare const PutSmsVirtualNumberServiceInfosRequest: S.Schema<PutSmsVirtualNumberServiceInfosRequest>;
|
|
2203
|
+
export interface PutSmsVirtualNumberServiceInfosResponse {
|
|
2204
|
+
}
|
|
2205
|
+
export declare const PutSmsVirtualNumberServiceInfosResponse: S.Schema<PutSmsVirtualNumberServiceInfosResponse>;
|
|
2206
|
+
export interface TransferSmsCreditsRequest {
|
|
2207
|
+
/** The internal name of your SMS offer */
|
|
2208
|
+
serviceName: string;
|
|
2209
|
+
/** Amount of credits to transfer. */
|
|
2210
|
+
credits: number;
|
|
2211
|
+
/** Sms account destination. */
|
|
2212
|
+
smsAccountTarget: string;
|
|
2213
|
+
}
|
|
2214
|
+
export declare const TransferSmsCreditsRequest: S.Schema<TransferSmsCreditsRequest>;
|
|
2215
|
+
export interface TransferSmsCreditsResponse {
|
|
2216
|
+
}
|
|
2217
|
+
export declare const TransferSmsCreditsResponse: S.Schema<TransferSmsCreditsResponse>;
|
|
2218
|
+
export interface ValidateSmsSenderRequest {
|
|
2219
|
+
/** The internal name of your SMS offer */
|
|
2220
|
+
serviceName: string;
|
|
2221
|
+
/** The sms sender */
|
|
2222
|
+
sender: string;
|
|
2223
|
+
/** The validation code */
|
|
2224
|
+
code: string;
|
|
2225
|
+
}
|
|
2226
|
+
export declare const ValidateSmsSenderRequest: S.Schema<ValidateSmsSenderRequest>;
|
|
2227
|
+
export interface ValidateSmsSenderResponse {
|
|
2228
|
+
}
|
|
2229
|
+
export declare const ValidateSmsSenderResponse: S.Schema<ValidateSmsSenderResponse>;
|
|
2230
|
+
export type CancelSmsBatchError = OvhOpError;
|
|
2231
|
+
/** Cancel a deferred batch (no SMS must have been sent) */
|
|
2232
|
+
export declare const cancelSmsBatch: API.OperationMethod<CancelSmsBatchRequest, SmsBatch, CancelSmsBatchError, OvhOpContext>;
|
|
2233
|
+
export type CreateSmsBatchError = OvhOpError;
|
|
2234
|
+
/** Create a batch */
|
|
2235
|
+
export declare const createSmsBatch: API.OperationMethod<CreateSmsBatchRequest, SmsBatch, CreateSmsBatchError, OvhOpContext>;
|
|
2236
|
+
export type CreateSmsEstimateError = OvhOpError;
|
|
2237
|
+
/** Get the encoding, length and number of SMS parts of a text message */
|
|
2238
|
+
export declare const createSmsEstimate: API.OperationMethod<CreateSmsEstimateRequest, SmsJobEstimate, CreateSmsEstimateError, OvhOpContext>;
|
|
2239
|
+
export type CreateSmsHlrError = OvhOpError;
|
|
2240
|
+
/** Add one or several sending hlr lookup request */
|
|
2241
|
+
export declare const createSmsHlr: API.OperationMethod<CreateSmsHlrRequest, SmsSmsSendingReport, CreateSmsHlrError, OvhOpContext>;
|
|
2242
|
+
export type CreateSmsJobError = OvhOpError;
|
|
2243
|
+
/** Add one or several sending jobs */
|
|
2244
|
+
export declare const createSmsJob: API.OperationMethod<CreateSmsJobRequest, SmsSmsSendingReport, CreateSmsJobError, OvhOpContext>;
|
|
2245
|
+
export type CreateSmsPhonebookError = OvhOpError;
|
|
2246
|
+
/** Add a phonebook. Return the bookKey. */
|
|
2247
|
+
export declare const createSmsPhonebook: API.OperationMethod<CreateSmsPhonebookRequest, CreateSmsPhonebookResponse, CreateSmsPhonebookError, OvhOpContext>;
|
|
2248
|
+
export type CreateSmsPhonebookPhonebookContactError = OvhOpError;
|
|
2249
|
+
/** Create a phonebook contact. Return identifier of the phonebook contact. */
|
|
2250
|
+
export declare const createSmsPhonebookPhonebookContact: API.OperationMethod<CreateSmsPhonebookPhonebookContactRequest, CreateSmsPhonebookPhonebookContactResponse, CreateSmsPhonebookPhonebookContactError, OvhOpContext>;
|
|
2251
|
+
export type CreateSmsReceiverError = OvhOpError;
|
|
2252
|
+
/** Add a new document of csv receivers */
|
|
2253
|
+
export declare const createSmsReceiver: API.OperationMethod<CreateSmsReceiverRequest, SmsReceiver, CreateSmsReceiverError, OvhOpContext>;
|
|
2254
|
+
export type CreateSmsReceiverCleanError = OvhOpError;
|
|
2255
|
+
/** Clean the invalid and inactive receivers in the document by requesting HLR on each receiver Clean the invalid and inactive receivers in the document by requesting HLR on each receiver. A report is sent by e-mail at the end of the operation. */
|
|
2256
|
+
export declare const createSmsReceiverClean: API.OperationMethod<CreateSmsReceiverCleanRequest, SmsReceiversAsynchronousCleanReport, CreateSmsReceiverCleanError, OvhOpContext>;
|
|
2257
|
+
export type CreateSmsSenderError = OvhOpError;
|
|
2258
|
+
/** Create the sms sender given */
|
|
2259
|
+
export declare const createSmsSender: API.OperationMethod<CreateSmsSenderRequest, CreateSmsSenderResponse, CreateSmsSenderError, OvhOpContext>;
|
|
2260
|
+
export type CreateSmsSenderDocumentError = OvhOpError;
|
|
2261
|
+
/** Create a new empty document */
|
|
2262
|
+
export declare const createSmsSenderDocument: API.OperationMethod<CreateSmsSenderDocumentRequest, SmsSenderDocument, CreateSmsSenderDocumentError, OvhOpContext>;
|
|
2263
|
+
export type CreateSmsSmppPasswordError = OvhOpError;
|
|
2264
|
+
/** Renew SMPP password */
|
|
2265
|
+
export declare const createSmsSmppPassword: API.OperationMethod<CreateSmsSmppPasswordRequest, CreateSmsSmppPasswordResponse, CreateSmsSmppPasswordError, OvhOpContext>;
|
|
2266
|
+
export type CreateSmsTemplatesControlError = OvhOpError;
|
|
2267
|
+
/** Create the sms template control given */
|
|
2268
|
+
export declare const createSmsTemplatesControl: API.OperationMethod<CreateSmsTemplatesControlRequest, CreateSmsTemplatesControlResponse, CreateSmsTemplatesControlError, OvhOpContext>;
|
|
2269
|
+
export type CreateSmsTemplatesControlRelaunchValidationError = OvhOpError;
|
|
2270
|
+
/** Attempt a new validation after moderation refusal */
|
|
2271
|
+
export declare const createSmsTemplatesControlRelaunchValidation: API.OperationMethod<CreateSmsTemplatesControlRelaunchValidationRequest, CreateSmsTemplatesControlRelaunchValidationResponse, CreateSmsTemplatesControlRelaunchValidationError, OvhOpContext>;
|
|
2272
|
+
export type CreateSmsUserError = OvhOpError;
|
|
2273
|
+
/** Create a new user for an sms account */
|
|
2274
|
+
export declare const createSmsUser: API.OperationMethod<CreateSmsUserRequest, CreateSmsUserResponse, CreateSmsUserError, OvhOpContext>;
|
|
2275
|
+
export type CreateSmsUserJobError = OvhOpError;
|
|
2276
|
+
/** Add one or several sending jobs */
|
|
2277
|
+
export declare const createSmsUserJob: API.OperationMethod<CreateSmsUserJobRequest, SmsSmsSendingReport, CreateSmsUserJobError, OvhOpContext>;
|
|
2278
|
+
export type CreateSmsUserReceiverError = OvhOpError;
|
|
2279
|
+
/** Add a new document of csv receivers */
|
|
2280
|
+
export declare const createSmsUserReceiver: API.OperationMethod<CreateSmsUserReceiverRequest, SmsReceiver, CreateSmsUserReceiverError, OvhOpContext>;
|
|
2281
|
+
export type CreateSmsUserReceiverCleanError = OvhOpError;
|
|
2282
|
+
/** Clean the invalid and inactive receivers in the document by requesting HLR on each receiver Clean the invalid and inactive receivers in the document by requesting HLR on each receiver. A report is sent by e-mail at the end of the operation. */
|
|
2283
|
+
export declare const createSmsUserReceiverClean: API.OperationMethod<CreateSmsUserReceiverCleanRequest, SmsReceiversAsynchronousCleanReport, CreateSmsUserReceiverCleanError, OvhOpContext>;
|
|
2284
|
+
export type CreateSmsVirtualNumberChatAccessError = OvhOpError;
|
|
2285
|
+
/** Create a new web access for this ressource */
|
|
2286
|
+
export declare const createSmsVirtualNumberChatAccess: API.OperationMethod<CreateSmsVirtualNumberChatAccessRequest, SmsChatAccess, CreateSmsVirtualNumberChatAccessError, OvhOpContext>;
|
|
2287
|
+
export type CreateSmsVirtualNumberJobError = OvhOpError;
|
|
2288
|
+
/** Add one or several sending jobs */
|
|
2289
|
+
export declare const createSmsVirtualNumberJob: API.OperationMethod<CreateSmsVirtualNumberJobRequest, SmsSmsSendingReport, CreateSmsVirtualNumberJobError, OvhOpContext>;
|
|
2290
|
+
export type DeleteSmsBatchError = OvhOpError;
|
|
2291
|
+
/** Remove a batch */
|
|
2292
|
+
export declare const deleteSmsBatch: API.OperationMethod<DeleteSmsBatchRequest, DeleteSmsBatchResponse, DeleteSmsBatchError, OvhOpContext>;
|
|
2293
|
+
export type DeleteSmsBlacklistError = OvhOpError;
|
|
2294
|
+
/** Delete the blacklisted sms number given */
|
|
2295
|
+
export declare const deleteSmsBlacklist: API.OperationMethod<DeleteSmsBlacklistRequest, DeleteSmsBlacklistResponse, DeleteSmsBlacklistError, OvhOpContext>;
|
|
2296
|
+
export type DeleteSmsIncomingError = OvhOpError;
|
|
2297
|
+
/** Delete the sms incoming history given */
|
|
2298
|
+
export declare const deleteSmsIncoming: API.OperationMethod<DeleteSmsIncomingRequest, DeleteSmsIncomingResponse, DeleteSmsIncomingError, OvhOpContext>;
|
|
2299
|
+
export type DeleteSmsJobError = OvhOpError;
|
|
2300
|
+
/** Delete the sms job given (stop sending) */
|
|
2301
|
+
export declare const deleteSmsJob: API.OperationMethod<DeleteSmsJobRequest, DeleteSmsJobResponse, DeleteSmsJobError, OvhOpContext>;
|
|
2302
|
+
export type DeleteSmsOutgoingError = OvhOpError;
|
|
2303
|
+
/** Delete outgoing SMS from history */
|
|
2304
|
+
export declare const deleteSmsOutgoing: API.OperationMethod<DeleteSmsOutgoingRequest, DeleteSmsOutgoingResponse, DeleteSmsOutgoingError, OvhOpContext>;
|
|
2305
|
+
export type DeleteSmsPhonebookError = OvhOpError;
|
|
2306
|
+
/** Delete a phonebook */
|
|
2307
|
+
export declare const deleteSmsPhonebook: API.OperationMethod<DeleteSmsPhonebookRequest, DeleteSmsPhonebookResponse, DeleteSmsPhonebookError, OvhOpContext>;
|
|
2308
|
+
export type DeleteSmsPhonebookPhonebookContactError = OvhOpError;
|
|
2309
|
+
/** Delete a phonebook contact */
|
|
2310
|
+
export declare const deleteSmsPhonebookPhonebookContact: API.OperationMethod<DeleteSmsPhonebookPhonebookContactRequest, DeleteSmsPhonebookPhonebookContactResponse, DeleteSmsPhonebookPhonebookContactError, OvhOpContext>;
|
|
2311
|
+
export type DeleteSmsReceiverError = OvhOpError;
|
|
2312
|
+
/** Delete the document from the slot */
|
|
2313
|
+
export declare const deleteSmsReceiver: API.OperationMethod<DeleteSmsReceiverRequest, DeleteSmsReceiverResponse, DeleteSmsReceiverError, OvhOpContext>;
|
|
2314
|
+
export type DeleteSmsSenderError = OvhOpError;
|
|
2315
|
+
/** Delete the sms sender given */
|
|
2316
|
+
export declare const deleteSmsSender: API.OperationMethod<DeleteSmsSenderRequest, DeleteSmsSenderResponse, DeleteSmsSenderError, OvhOpContext>;
|
|
2317
|
+
export type DeleteSmsTemplatesControlError = OvhOpError;
|
|
2318
|
+
/** Delete the sms template control */
|
|
2319
|
+
export declare const deleteSmsTemplatesControl: API.OperationMethod<DeleteSmsTemplatesControlRequest, DeleteSmsTemplatesControlResponse, DeleteSmsTemplatesControlError, OvhOpContext>;
|
|
2320
|
+
export type DeleteSmsUserError = OvhOpError;
|
|
2321
|
+
/** Delete the sms user given */
|
|
2322
|
+
export declare const deleteSmsUser: API.OperationMethod<DeleteSmsUserRequest, DeleteSmsUserResponse, DeleteSmsUserError, OvhOpContext>;
|
|
2323
|
+
export type DeleteSmsUserIncomingError = OvhOpError;
|
|
2324
|
+
/** Delete the sms incoming history given */
|
|
2325
|
+
export declare const deleteSmsUserIncoming: API.OperationMethod<DeleteSmsUserIncomingRequest, DeleteSmsUserIncomingResponse, DeleteSmsUserIncomingError, OvhOpContext>;
|
|
2326
|
+
export type DeleteSmsUserJobError = OvhOpError;
|
|
2327
|
+
/** Delete the sms job given (stop sending) */
|
|
2328
|
+
export declare const deleteSmsUserJob: API.OperationMethod<DeleteSmsUserJobRequest, DeleteSmsUserJobResponse, DeleteSmsUserJobError, OvhOpContext>;
|
|
2329
|
+
export type DeleteSmsUserOutgoingError = OvhOpError;
|
|
2330
|
+
/** Delete the sms outgoing history given */
|
|
2331
|
+
export declare const deleteSmsUserOutgoing: API.OperationMethod<DeleteSmsUserOutgoingRequest, DeleteSmsUserOutgoingResponse, DeleteSmsUserOutgoingError, OvhOpContext>;
|
|
2332
|
+
export type DeleteSmsUserReceiverError = OvhOpError;
|
|
2333
|
+
/** Delete the document from the slot */
|
|
2334
|
+
export declare const deleteSmsUserReceiver: API.OperationMethod<DeleteSmsUserReceiverRequest, DeleteSmsUserReceiverResponse, DeleteSmsUserReceiverError, OvhOpContext>;
|
|
2335
|
+
export type DeleteSmsVirtualNumberChatAccessError = OvhOpError;
|
|
2336
|
+
/** Delete the given web access */
|
|
2337
|
+
export declare const deleteSmsVirtualNumberChatAccess: API.OperationMethod<DeleteSmsVirtualNumberChatAccessRequest, DeleteSmsVirtualNumberChatAccessResponse, DeleteSmsVirtualNumberChatAccessError, OvhOpContext>;
|
|
2338
|
+
export type DeleteSmsVirtualNumberIncomingError = OvhOpError;
|
|
2339
|
+
/** Delete the sms incoming history given */
|
|
2340
|
+
export declare const deleteSmsVirtualNumberIncoming: API.OperationMethod<DeleteSmsVirtualNumberIncomingRequest, DeleteSmsVirtualNumberIncomingResponse, DeleteSmsVirtualNumberIncomingError, OvhOpContext>;
|
|
2341
|
+
export type DeleteSmsVirtualNumberJobError = OvhOpError;
|
|
2342
|
+
/** Delete the sms job given (stop sending) */
|
|
2343
|
+
export declare const deleteSmsVirtualNumberJob: API.OperationMethod<DeleteSmsVirtualNumberJobRequest, DeleteSmsVirtualNumberJobResponse, DeleteSmsVirtualNumberJobError, OvhOpContext>;
|
|
2344
|
+
export type DeleteSmsVirtualNumberOutgoingError = OvhOpError;
|
|
2345
|
+
/** Delete the sms outgoing history given */
|
|
2346
|
+
export declare const deleteSmsVirtualNumberOutgoing: API.OperationMethod<DeleteSmsVirtualNumberOutgoingRequest, DeleteSmsVirtualNumberOutgoingResponse, DeleteSmsVirtualNumberOutgoingError, OvhOpContext>;
|
|
2347
|
+
export type GetSmsError = OvhOpError;
|
|
2348
|
+
/** Get this object properties */
|
|
2349
|
+
export declare const getSms: API.OperationMethod<GetSmsRequest, SmsAccountWithIAM, GetSmsError, OvhOpContext>;
|
|
2350
|
+
export type GetSmsBatchError = OvhOpError;
|
|
2351
|
+
/** Get a batch */
|
|
2352
|
+
export declare const getSmsBatch: API.OperationMethod<GetSmsBatchRequest, SmsBatch, GetSmsBatchError, OvhOpContext>;
|
|
2353
|
+
export type GetSmsBatchStatisticsError = OvhOpError;
|
|
2354
|
+
/** Batch's statistics */
|
|
2355
|
+
export declare const getSmsBatchStatistics: API.OperationMethod<GetSmsBatchStatisticsRequest, SmsBatchStatistics, GetSmsBatchStatisticsError, OvhOpContext>;
|
|
2356
|
+
export type GetSmsBlacklistError = OvhOpError;
|
|
2357
|
+
/** Get this object properties */
|
|
2358
|
+
export declare const getSmsBlacklist: API.OperationMethod<GetSmsBlacklistRequest, SmsBlacklist, GetSmsBlacklistError, OvhOpContext>;
|
|
2359
|
+
export type GetSmsDocumentError = OvhOpError;
|
|
2360
|
+
/** Get the /me/document id generated */
|
|
2361
|
+
export declare const getSmsDocument: API.OperationMethod<GetSmsDocumentRequest, GetSmsDocumentResponse, GetSmsDocumentError, OvhOpContext>;
|
|
2362
|
+
export type GetSmsHlrError = OvhOpError;
|
|
2363
|
+
/** Get this object properties */
|
|
2364
|
+
export declare const getSmsHlr: API.OperationMethod<GetSmsHlrRequest, SmsHlrLookupNumber, GetSmsHlrError, OvhOpContext>;
|
|
2365
|
+
export type GetSmsHlrOperatorError = OvhOpError;
|
|
2366
|
+
/** Get this object properties */
|
|
2367
|
+
export declare const getSmsHlrOperator: API.OperationMethod<GetSmsHlrOperatorRequest, SmsHlr, GetSmsHlrOperatorError, OvhOpContext>;
|
|
2368
|
+
export type GetSmsIncomingError = OvhOpError;
|
|
2369
|
+
/** Get this object properties */
|
|
2370
|
+
export declare const getSmsIncoming: API.OperationMethod<GetSmsIncomingRequest, SmsIncoming, GetSmsIncomingError, OvhOpContext>;
|
|
2371
|
+
export type GetSmsJobError = OvhOpError;
|
|
2372
|
+
/** Get this object properties */
|
|
2373
|
+
export declare const getSmsJob: API.OperationMethod<GetSmsJobRequest, SmsJob, GetSmsJobError, OvhOpContext>;
|
|
2374
|
+
export type GetSmsOutgoingError = OvhOpError;
|
|
2375
|
+
/** Get SMS details */
|
|
2376
|
+
export declare const getSmsOutgoing: API.OperationMethod<GetSmsOutgoingRequest, SmsOutgoing, GetSmsOutgoingError, OvhOpContext>;
|
|
2377
|
+
export type GetSmsOutgoingHlrError = OvhOpError;
|
|
2378
|
+
/** Get this object properties */
|
|
2379
|
+
export declare const getSmsOutgoingHlr: API.OperationMethod<GetSmsOutgoingHlrRequest, SmsHlr, GetSmsOutgoingHlrError, OvhOpContext>;
|
|
2380
|
+
export type GetSmsPhonebookError = OvhOpError;
|
|
2381
|
+
/** Get this object properties */
|
|
2382
|
+
export declare const getSmsPhonebook: API.OperationMethod<GetSmsPhonebookRequest, SmsPhonebook, GetSmsPhonebookError, OvhOpContext>;
|
|
2383
|
+
export type GetSmsPhonebookExportError = OvhOpError;
|
|
2384
|
+
/** Export the phonebook's contacts */
|
|
2385
|
+
export declare const getSmsPhonebookExport: API.OperationMethod<GetSmsPhonebookExportRequest, TelephonyPcsFile, GetSmsPhonebookExportError, OvhOpContext>;
|
|
2386
|
+
export type GetSmsPhonebookPhonebookContactError = OvhOpError;
|
|
2387
|
+
/** Get this object properties */
|
|
2388
|
+
export declare const getSmsPhonebookPhonebookContact: API.OperationMethod<GetSmsPhonebookPhonebookContactRequest, SmsPhonebookContact, GetSmsPhonebookPhonebookContactError, OvhOpContext>;
|
|
2389
|
+
export type GetSmsPttsError = OvhOpError;
|
|
2390
|
+
/** Get informations about the given ptt code */
|
|
2391
|
+
export declare const getSmsPtts: API.OperationMethod<GetSmsPttsRequest, SmsPttDetails, GetSmsPttsError, OvhOpContext>;
|
|
2392
|
+
export type GetSmsRateDestinationsError = OvhOpError;
|
|
2393
|
+
/** Get the prices and credits to send a SMS towards given country */
|
|
2394
|
+
export declare const getSmsRateDestinations: API.OperationMethod<GetSmsRateDestinationsRequest, SmsDestinationRates, GetSmsRateDestinationsError, OvhOpContext>;
|
|
2395
|
+
export type GetSmsReceiverError = OvhOpError;
|
|
2396
|
+
/** Get this object properties */
|
|
2397
|
+
export declare const getSmsReceiver: API.OperationMethod<GetSmsReceiverRequest, SmsReceiver, GetSmsReceiverError, OvhOpContext>;
|
|
2398
|
+
export type GetSmsReceiverCsvError = OvhOpError;
|
|
2399
|
+
/** Get the document data container */
|
|
2400
|
+
export declare const getSmsReceiverCsv: API.OperationMethod<GetSmsReceiverCsvRequest, GetSmsReceiverCsvResponse, GetSmsReceiverCsvError, OvhOpContext>;
|
|
2401
|
+
export type GetSmsSenderError = OvhOpError;
|
|
2402
|
+
/** Get this object properties */
|
|
2403
|
+
export declare const getSmsSender: API.OperationMethod<GetSmsSenderRequest, SmsSender, GetSmsSenderError, OvhOpContext>;
|
|
2404
|
+
export type GetSmsSenderDocumentError = OvhOpError;
|
|
2405
|
+
/** Get this object properties */
|
|
2406
|
+
export declare const getSmsSenderDocument: API.OperationMethod<GetSmsSenderDocumentRequest, SmsSenderDocument, GetSmsSenderDocumentError, OvhOpContext>;
|
|
2407
|
+
export type GetSmsServiceInfosError = OvhOpError;
|
|
2408
|
+
/** Get service information */
|
|
2409
|
+
export declare const getSmsServiceInfos: API.OperationMethod<GetSmsServiceInfosRequest, ServicesService, GetSmsServiceInfosError, OvhOpContext>;
|
|
2410
|
+
export type GetSmsSmppSettingsError = OvhOpError;
|
|
2411
|
+
/** Get SMPP settings */
|
|
2412
|
+
export declare const getSmsSmppSettings: API.OperationMethod<GetSmsSmppSettingsRequest, SmsSettings, GetSmsSmppSettingsError, OvhOpContext>;
|
|
2413
|
+
export type GetSmsTaskError = OvhOpError;
|
|
2414
|
+
/** Get this object properties */
|
|
2415
|
+
export declare const getSmsTask: API.OperationMethod<GetSmsTaskRequest, SmsTask, GetSmsTaskError, OvhOpContext>;
|
|
2416
|
+
export type GetSmsTemplatesControlError = OvhOpError;
|
|
2417
|
+
/** Get this object properties */
|
|
2418
|
+
export declare const getSmsTemplatesControl: API.OperationMethod<GetSmsTemplatesControlRequest, SmsTemplateControl, GetSmsTemplatesControlError, OvhOpContext>;
|
|
2419
|
+
export type GetSmsUserError = OvhOpError;
|
|
2420
|
+
/** Get this object properties */
|
|
2421
|
+
export declare const getSmsUser: API.OperationMethod<GetSmsUserRequest, SmsUser, GetSmsUserError, OvhOpContext>;
|
|
2422
|
+
export type GetSmsUserDocumentError = OvhOpError;
|
|
2423
|
+
/** Get the /me/document id generated */
|
|
2424
|
+
export declare const getSmsUserDocument: API.OperationMethod<GetSmsUserDocumentRequest, GetSmsUserDocumentResponse, GetSmsUserDocumentError, OvhOpContext>;
|
|
2425
|
+
export type GetSmsUserIncomingError = OvhOpError;
|
|
2426
|
+
/** Get this object properties */
|
|
2427
|
+
export declare const getSmsUserIncoming: API.OperationMethod<GetSmsUserIncomingRequest, SmsIncoming, GetSmsUserIncomingError, OvhOpContext>;
|
|
2428
|
+
export type GetSmsUserJobError = OvhOpError;
|
|
2429
|
+
/** Get this object properties */
|
|
2430
|
+
export declare const getSmsUserJob: API.OperationMethod<GetSmsUserJobRequest, SmsJob, GetSmsUserJobError, OvhOpContext>;
|
|
2431
|
+
export type GetSmsUserOutgoingError = OvhOpError;
|
|
2432
|
+
/** Get this object properties */
|
|
2433
|
+
export declare const getSmsUserOutgoing: API.OperationMethod<GetSmsUserOutgoingRequest, SmsOutgoing, GetSmsUserOutgoingError, OvhOpContext>;
|
|
2434
|
+
export type GetSmsUserOutgoingHlrError = OvhOpError;
|
|
2435
|
+
/** Get this object properties */
|
|
2436
|
+
export declare const getSmsUserOutgoingHlr: API.OperationMethod<GetSmsUserOutgoingHlrRequest, SmsHlr, GetSmsUserOutgoingHlrError, OvhOpContext>;
|
|
2437
|
+
export type GetSmsUserReceiverError = OvhOpError;
|
|
2438
|
+
/** Get this object properties */
|
|
2439
|
+
export declare const getSmsUserReceiver: API.OperationMethod<GetSmsUserReceiverRequest, SmsReceiver, GetSmsUserReceiverError, OvhOpContext>;
|
|
2440
|
+
export type GetSmsUserReceiverCsvError = OvhOpError;
|
|
2441
|
+
/** Get the document data container */
|
|
2442
|
+
export declare const getSmsUserReceiverCsv: API.OperationMethod<GetSmsUserReceiverCsvRequest, GetSmsUserReceiverCsvResponse, GetSmsUserReceiverCsvError, OvhOpContext>;
|
|
2443
|
+
export type GetSmsVirtualNumberError = OvhOpError;
|
|
2444
|
+
/** Get this object properties */
|
|
2445
|
+
export declare const getSmsVirtualNumber: API.OperationMethod<GetSmsVirtualNumberRequest, SmsVirtualNumberGenericServiceWithIAM, GetSmsVirtualNumberError, OvhOpContext>;
|
|
2446
|
+
export type GetSmsVirtualNumberByNumberError = OvhOpError;
|
|
2447
|
+
/** Get this object properties */
|
|
2448
|
+
export declare const getSmsVirtualNumberByNumber: API.OperationMethod<GetSmsVirtualNumberByNumberRequest, SmsVirtualNumber, GetSmsVirtualNumberByNumberError, OvhOpContext>;
|
|
2449
|
+
export type GetSmsVirtualNumberChatAccessError = OvhOpError;
|
|
2450
|
+
/** Get this object properties */
|
|
2451
|
+
export declare const getSmsVirtualNumberChatAccess: API.OperationMethod<GetSmsVirtualNumberChatAccessRequest, SmsChatAccess, GetSmsVirtualNumberChatAccessError, OvhOpContext>;
|
|
2452
|
+
export type GetSmsVirtualNumberIncomingError = OvhOpError;
|
|
2453
|
+
/** Get this object properties */
|
|
2454
|
+
export declare const getSmsVirtualNumberIncoming: API.OperationMethod<GetSmsVirtualNumberIncomingRequest, SmsIncoming, GetSmsVirtualNumberIncomingError, OvhOpContext>;
|
|
2455
|
+
export type GetSmsVirtualNumberJobError = OvhOpError;
|
|
2456
|
+
/** Get this object properties */
|
|
2457
|
+
export declare const getSmsVirtualNumberJob: API.OperationMethod<GetSmsVirtualNumberJobRequest, SmsVirtualNumberJob, GetSmsVirtualNumberJobError, OvhOpContext>;
|
|
2458
|
+
export type GetSmsVirtualNumberOutgoingError = OvhOpError;
|
|
2459
|
+
/** Get this object properties */
|
|
2460
|
+
export declare const getSmsVirtualNumberOutgoing: API.OperationMethod<GetSmsVirtualNumberOutgoingRequest, SmsOutgoing, GetSmsVirtualNumberOutgoingError, OvhOpContext>;
|
|
2461
|
+
export type GetSmsVirtualNumberOutgoingHlrError = OvhOpError;
|
|
2462
|
+
/** Get this object properties */
|
|
2463
|
+
export declare const getSmsVirtualNumberOutgoingHlr: API.OperationMethod<GetSmsVirtualNumberOutgoingHlrRequest, SmsHlr, GetSmsVirtualNumberOutgoingHlrError, OvhOpContext>;
|
|
2464
|
+
export type GetSmsVirtualNumberServiceInfosError = OvhOpError;
|
|
2465
|
+
/** Get service information */
|
|
2466
|
+
export declare const getSmsVirtualNumberServiceInfos: API.OperationMethod<GetSmsVirtualNumberServiceInfosRequest, ServicesService, GetSmsVirtualNumberServiceInfosError, OvhOpContext>;
|
|
2467
|
+
export type ImportSmsPhonebookError = OvhOpError;
|
|
2468
|
+
/** Import a contacts file. Supported formats are Excel (.xls and .xlsx) and CSV */
|
|
2469
|
+
export declare const importSmsPhonebook: API.OperationMethod<ImportSmsPhonebookRequest, TelephonyTask, ImportSmsPhonebookError, OvhOpContext>;
|
|
2470
|
+
export type ListSmsError = OvhOpError;
|
|
2471
|
+
/** List available services */
|
|
2472
|
+
export declare const listSms: API.OperationMethod<ListSmsRequest, ListSmsResponse, ListSmsError, OvhOpContext>;
|
|
2473
|
+
export type ListSmsBatchesError = OvhOpError;
|
|
2474
|
+
/** Get batches list */
|
|
2475
|
+
export declare const listSmsBatches: API.OperationMethod<ListSmsBatchesRequest, ListSmsBatchesResponse, ListSmsBatchesError, OvhOpContext>;
|
|
2476
|
+
export type ListSmsBlacklistsError = OvhOpError;
|
|
2477
|
+
/** Numbers blacklisted associated to the sms account */
|
|
2478
|
+
export declare const listSmsBlacklists: API.OperationMethod<ListSmsBlacklistsRequest, ListSmsBlacklistsResponse, ListSmsBlacklistsError, OvhOpContext>;
|
|
2479
|
+
export type ListSmsExceptionsError = OvhOpError;
|
|
2480
|
+
/** Describe filter exceptions in sms sending from a specific receiver. */
|
|
2481
|
+
export declare const listSmsExceptions: API.OperationMethod<ListSmsExceptionsRequest, ListSmsExceptionsResponse, ListSmsExceptionsError, OvhOpContext>;
|
|
2482
|
+
export type ListSmsHlrError = OvhOpError;
|
|
2483
|
+
/** Home Location Register informations. Give informations about a given cellular phone. */
|
|
2484
|
+
export declare const listSmsHlr: API.OperationMethod<ListSmsHlrRequest, ListSmsHlrResponse, ListSmsHlrError, OvhOpContext>;
|
|
2485
|
+
export type ListSmsIncomingError = OvhOpError;
|
|
2486
|
+
/** Sms received associated to the sms account */
|
|
2487
|
+
export declare const listSmsIncoming: API.OperationMethod<ListSmsIncomingRequest, ListSmsIncomingResponse, ListSmsIncomingError, OvhOpContext>;
|
|
2488
|
+
export type ListSmsJobsError = OvhOpError;
|
|
2489
|
+
/** Sms in pending associated to the sms account */
|
|
2490
|
+
export declare const listSmsJobs: API.OperationMethod<ListSmsJobsRequest, ListSmsJobsResponse, ListSmsJobsError, OvhOpContext>;
|
|
2491
|
+
export type ListSmsOutgoingError = OvhOpError;
|
|
2492
|
+
/** Get SMS list */
|
|
2493
|
+
export declare const listSmsOutgoing: API.OperationMethod<ListSmsOutgoingRequest, ListSmsOutgoingResponse, ListSmsOutgoingError, OvhOpContext>;
|
|
2494
|
+
export type ListSmsPhonebookPhonebookContactError = OvhOpError;
|
|
2495
|
+
/** Phonebook contacts */
|
|
2496
|
+
export declare const listSmsPhonebookPhonebookContact: API.OperationMethod<ListSmsPhonebookPhonebookContactRequest, ListSmsPhonebookPhonebookContactResponse, ListSmsPhonebookPhonebookContactError, OvhOpContext>;
|
|
2497
|
+
export type ListSmsPhonebooksError = OvhOpError;
|
|
2498
|
+
/** Return phonebooks associated to this account */
|
|
2499
|
+
export declare const listSmsPhonebooks: API.OperationMethod<ListSmsPhonebooksRequest, ListSmsPhonebooksResponse, ListSmsPhonebooksError, OvhOpContext>;
|
|
2500
|
+
export type ListSmsRatePacksError = OvhOpError;
|
|
2501
|
+
/** Get the prices and credits of all the SMS packs with informations about the destination country */
|
|
2502
|
+
export declare const listSmsRatePacks: API.OperationMethod<ListSmsRatePacksRequest, ListSmsRatePacksResponse, ListSmsRatePacksError, OvhOpContext>;
|
|
2503
|
+
export type ListSmsReceiversError = OvhOpError;
|
|
2504
|
+
/** Receivers preloaded from text or csv document file */
|
|
2505
|
+
export declare const listSmsReceivers: API.OperationMethod<ListSmsReceiversRequest, ListSmsReceiversResponse, ListSmsReceiversError, OvhOpContext>;
|
|
2506
|
+
export type ListSmsSeeOffersError = OvhOpError;
|
|
2507
|
+
/** Describe SMS offers available. */
|
|
2508
|
+
export declare const listSmsSeeOffers: API.OperationMethod<ListSmsSeeOffersRequest, ListSmsSeeOffersResponse, ListSmsSeeOffersError, OvhOpContext>;
|
|
2509
|
+
export type ListSmsSenderDocumentsError = OvhOpError;
|
|
2510
|
+
/** Documents linked to SMS sender for validation purpose */
|
|
2511
|
+
export declare const listSmsSenderDocuments: API.OperationMethod<ListSmsSenderDocumentsRequest, ListSmsSenderDocumentsResponse, ListSmsSenderDocumentsError, OvhOpContext>;
|
|
2512
|
+
export type ListSmsSendersError = OvhOpError;
|
|
2513
|
+
/** Senders allowed associated to the sms account */
|
|
2514
|
+
export declare const listSmsSenders: API.OperationMethod<ListSmsSendersRequest, ListSmsSendersResponse, ListSmsSendersError, OvhOpContext>;
|
|
2515
|
+
export type ListSmsSendersAvailableForValidationError = OvhOpError;
|
|
2516
|
+
/** The senders that are attached to your personal informations or OVH services and that can be automatically validated */
|
|
2517
|
+
export declare const listSmsSendersAvailableForValidation: API.OperationMethod<ListSmsSendersAvailableForValidationRequest, ListSmsSendersAvailableForValidationResponse, ListSmsSendersAvailableForValidationError, OvhOpContext>;
|
|
2518
|
+
export type ListSmsSmppAllowedIPsError = OvhOpError;
|
|
2519
|
+
/** Get SMPP allowed IPs */
|
|
2520
|
+
export declare const listSmsSmppAllowedIPs: API.OperationMethod<ListSmsSmppAllowedIPsRequest, ListSmsSmppAllowedIPsResponse, ListSmsSmppAllowedIPsError, OvhOpContext>;
|
|
2521
|
+
export type ListSmsTaskError = OvhOpError;
|
|
2522
|
+
/** Operations on a SMS service */
|
|
2523
|
+
export declare const listSmsTask: API.OperationMethod<ListSmsTaskRequest, ListSmsTaskResponse, ListSmsTaskError, OvhOpContext>;
|
|
2524
|
+
export type ListSmsTemplatesControlError = OvhOpError;
|
|
2525
|
+
/** Template pattern filled up for moderation (Needed to send in US country) */
|
|
2526
|
+
export declare const listSmsTemplatesControl: API.OperationMethod<ListSmsTemplatesControlRequest, ListSmsTemplatesControlResponse, ListSmsTemplatesControlError, OvhOpContext>;
|
|
2527
|
+
export type ListSmsUserIncomingError = OvhOpError;
|
|
2528
|
+
/** Sms received associated to the sms user */
|
|
2529
|
+
export declare const listSmsUserIncoming: API.OperationMethod<ListSmsUserIncomingRequest, ListSmsUserIncomingResponse, ListSmsUserIncomingError, OvhOpContext>;
|
|
2530
|
+
export type ListSmsUserJobsError = OvhOpError;
|
|
2531
|
+
/** Sms in pending associated to the sms user */
|
|
2532
|
+
export declare const listSmsUserJobs: API.OperationMethod<ListSmsUserJobsRequest, ListSmsUserJobsResponse, ListSmsUserJobsError, OvhOpContext>;
|
|
2533
|
+
export type ListSmsUserOutgoingError = OvhOpError;
|
|
2534
|
+
/** Sms sent associated to the sms user */
|
|
2535
|
+
export declare const listSmsUserOutgoing: API.OperationMethod<ListSmsUserOutgoingRequest, ListSmsUserOutgoingResponse, ListSmsUserOutgoingError, OvhOpContext>;
|
|
2536
|
+
export type ListSmsUserReceiversError = OvhOpError;
|
|
2537
|
+
/** Receivers preloaded from text or csv document file */
|
|
2538
|
+
export declare const listSmsUserReceivers: API.OperationMethod<ListSmsUserReceiversRequest, ListSmsUserReceiversResponse, ListSmsUserReceiversError, OvhOpContext>;
|
|
2539
|
+
export type ListSmsUsersError = OvhOpError;
|
|
2540
|
+
/** Users associated to the sms account */
|
|
2541
|
+
export declare const listSmsUsers: API.OperationMethod<ListSmsUsersRequest, ListSmsUsersResponse, ListSmsUsersError, OvhOpContext>;
|
|
2542
|
+
export type ListSmsVirtualNumberIncomingError = OvhOpError;
|
|
2543
|
+
/** Sms received associated to the sms account */
|
|
2544
|
+
export declare const listSmsVirtualNumberIncoming: API.OperationMethod<ListSmsVirtualNumberIncomingRequest, ListSmsVirtualNumberIncomingResponse, ListSmsVirtualNumberIncomingError, OvhOpContext>;
|
|
2545
|
+
export type ListSmsVirtualNumberJobsError = OvhOpError;
|
|
2546
|
+
/** Sms in pending associated to the sms account */
|
|
2547
|
+
export declare const listSmsVirtualNumberJobs: API.OperationMethod<ListSmsVirtualNumberJobsRequest, ListSmsVirtualNumberJobsResponse, ListSmsVirtualNumberJobsError, OvhOpContext>;
|
|
2548
|
+
export type ListSmsVirtualNumberOutgoingError = OvhOpError;
|
|
2549
|
+
/** Sms sent associated to the sms account */
|
|
2550
|
+
export declare const listSmsVirtualNumberOutgoing: API.OperationMethod<ListSmsVirtualNumberOutgoingRequest, ListSmsVirtualNumberOutgoingResponse, ListSmsVirtualNumberOutgoingError, OvhOpContext>;
|
|
2551
|
+
export type ListSmsVirtualNumbersError = OvhOpError;
|
|
2552
|
+
/** Your virtual numbers */
|
|
2553
|
+
export declare const listSmsVirtualNumbers: API.OperationMethod<ListSmsVirtualNumbersRequest, ListSmsVirtualNumbersResponse, ListSmsVirtualNumbersError, OvhOpContext>;
|
|
2554
|
+
export type ListSmsVirtualNumbers2Error = OvhOpError;
|
|
2555
|
+
/** Virtual numbers associated to the sms account */
|
|
2556
|
+
export declare const listSmsVirtualNumbers2: API.OperationMethod<ListSmsVirtualNumbersRequest2, ListSmsVirtualNumbersResponse2, ListSmsVirtualNumbers2Error, OvhOpContext>;
|
|
2557
|
+
export type PutSmsError = OvhOpError;
|
|
2558
|
+
/** Alter this object properties */
|
|
2559
|
+
export declare const putSms: API.OperationMethod<PutSmsRequest, PutSmsResponse, PutSmsError, OvhOpContext>;
|
|
2560
|
+
export type PutSmsBatchError = OvhOpError;
|
|
2561
|
+
/** Update a batch */
|
|
2562
|
+
export declare const putSmsBatch: API.OperationMethod<PutSmsBatchRequest, SmsBatch, PutSmsBatchError, OvhOpContext>;
|
|
2563
|
+
export type PutSmsPhonebookError = OvhOpError;
|
|
2564
|
+
/** Alter this object properties */
|
|
2565
|
+
export declare const putSmsPhonebook: API.OperationMethod<PutSmsPhonebookRequest, PutSmsPhonebookResponse, PutSmsPhonebookError, OvhOpContext>;
|
|
2566
|
+
export type PutSmsPhonebookPhonebookContactError = OvhOpError;
|
|
2567
|
+
/** Alter this object properties */
|
|
2568
|
+
export declare const putSmsPhonebookPhonebookContact: API.OperationMethod<PutSmsPhonebookPhonebookContactRequest, PutSmsPhonebookPhonebookContactResponse, PutSmsPhonebookPhonebookContactError, OvhOpContext>;
|
|
2569
|
+
export type PutSmsReceiverError = OvhOpError;
|
|
2570
|
+
/** Alter this object properties */
|
|
2571
|
+
export declare const putSmsReceiver: API.OperationMethod<PutSmsReceiverRequest, PutSmsReceiverResponse, PutSmsReceiverError, OvhOpContext>;
|
|
2572
|
+
export type PutSmsSenderError = OvhOpError;
|
|
2573
|
+
/** Alter this object properties */
|
|
2574
|
+
export declare const putSmsSender: API.OperationMethod<PutSmsSenderRequest, PutSmsSenderResponse, PutSmsSenderError, OvhOpContext>;
|
|
2575
|
+
export type PutSmsSenderDocumentError = OvhOpError;
|
|
2576
|
+
/** Alter this object properties */
|
|
2577
|
+
export declare const putSmsSenderDocument: API.OperationMethod<PutSmsSenderDocumentRequest, PutSmsSenderDocumentResponse, PutSmsSenderDocumentError, OvhOpContext>;
|
|
2578
|
+
export type PutSmsServiceInfosError = OvhOpError;
|
|
2579
|
+
/** Update service information */
|
|
2580
|
+
export declare const putSmsServiceInfos: API.OperationMethod<PutSmsServiceInfosRequest, PutSmsServiceInfosResponse, PutSmsServiceInfosError, OvhOpContext>;
|
|
2581
|
+
export type PutSmsSmppAllowedIPsError = OvhOpError;
|
|
2582
|
+
/** Add or remove allowed IPs */
|
|
2583
|
+
export declare const putSmsSmppAllowedIPs: API.OperationMethod<PutSmsSmppAllowedIPsRequest, PutSmsSmppAllowedIPsResponse, PutSmsSmppAllowedIPsError, OvhOpContext>;
|
|
2584
|
+
export type PutSmsTemplatesControlError = OvhOpError;
|
|
2585
|
+
/** Alter this object properties */
|
|
2586
|
+
export declare const putSmsTemplatesControl: API.OperationMethod<PutSmsTemplatesControlRequest, PutSmsTemplatesControlResponse, PutSmsTemplatesControlError, OvhOpContext>;
|
|
2587
|
+
export type PutSmsUserError = OvhOpError;
|
|
2588
|
+
/** Alter this object properties */
|
|
2589
|
+
export declare const putSmsUser: API.OperationMethod<PutSmsUserRequest, PutSmsUserResponse, PutSmsUserError, OvhOpContext>;
|
|
2590
|
+
export type PutSmsUserReceiverError = OvhOpError;
|
|
2591
|
+
/** Alter this object properties */
|
|
2592
|
+
export declare const putSmsUserReceiver: API.OperationMethod<PutSmsUserReceiverRequest, PutSmsUserReceiverResponse, PutSmsUserReceiverError, OvhOpContext>;
|
|
2593
|
+
export type PutSmsVirtualNumberServiceInfosError = OvhOpError;
|
|
2594
|
+
/** Update service information */
|
|
2595
|
+
export declare const putSmsVirtualNumberServiceInfos: API.OperationMethod<PutSmsVirtualNumberServiceInfosRequest, PutSmsVirtualNumberServiceInfosResponse, PutSmsVirtualNumberServiceInfosError, OvhOpContext>;
|
|
2596
|
+
export type TransferSmsCreditsError = OvhOpError;
|
|
2597
|
+
/** Credit transfer between two sms accounts. */
|
|
2598
|
+
export declare const transferSmsCredits: API.OperationMethod<TransferSmsCreditsRequest, TransferSmsCreditsResponse, TransferSmsCreditsError, OvhOpContext>;
|
|
2599
|
+
export type ValidateSmsSenderError = OvhOpError;
|
|
2600
|
+
/** Validate a given sender with an activation code. */
|
|
2601
|
+
export declare const validateSmsSender: API.OperationMethod<ValidateSmsSenderRequest, ValidateSmsSenderResponse, ValidateSmsSenderError, OvhOpContext>;
|
|
2602
|
+
//# sourceMappingURL=sms.d.ts.map
|