UNPKG

375 kBTypeScriptView Raw
1export declare namespace services {
2 /**
3 * Represents the interface between ApiClient and a Service Client.
4 * @export
5 * @interface ApiClientMessage
6 */
7 interface ApiClientMessage {
8 headers: Array<{
9 key: string;
10 value: string;
11 }>;
12 body?: string;
13 }
14 /**
15 * Represents a request sent from Service Clients to an ApiClient implementation.
16 * @export
17 * @interface ApiClientRequest
18 * @extends {ApiClientMessage}
19 */
20 interface ApiClientRequest extends ApiClientMessage {
21 url: string;
22 method: string;
23 }
24 /**
25 * Represents a response returned by ApiClient implementation to a Service Client.
26 * @export
27 * @interface ApiClientResponse
28 * @extends {ApiClientMessage}
29 */
30 interface ApiClientResponse extends ApiClientMessage {
31 /**
32 * Result code of the attempt to satisfy the request. Normally this
33 * corresponds to the HTTP status code returned by the server.
34 */
35 statusCode: number;
36 }
37 /**
38 * Represents a response with parsed body.
39 * @export
40 * @interface ApiResponse
41 */
42 interface ApiResponse {
43 headers: Array<{
44 key: string;
45 value: string;
46 }>;
47 body?: any;
48 statusCode: number;
49 }
50 /**
51 * Represents a basic contract for API request execution
52 * @export
53 * @interface ApiClient
54 */
55 interface ApiClient {
56 /**
57 * Dispatches a request to an API endpoint described in the request.
58 * An ApiClient is expected to resolve the Promise in the case an API returns a non-200 HTTP
59 * status code. The responsibility of translating a particular response code to an error lies with the
60 * caller to invoke.
61 * @param {ApiClientRequest} request request to dispatch to the ApiClient
62 * @returns {Promise<ApiClientResponse>} Response from the ApiClient
63 * @memberof ApiClient
64 */
65 invoke(request: ApiClientRequest): Promise<ApiClientResponse>;
66 }
67 /**
68 * Represents an interface that provides API configuration options needed by service clients.
69 * @interface ApiConfiguration
70 */
71 interface ApiConfiguration {
72 /**
73 * Configured ApiClient implementation
74 */
75 apiClient: ApiClient;
76 /**
77 * Authorization value to be used on any calls of the service client instance
78 */
79 authorizationValue: string;
80 /**
81 * Endpoint to hit by the service client instance
82 */
83 apiEndpoint: string;
84 }
85 /**
86 * Class to be used as the base class for the generated service clients.
87 */
88 abstract class BaseServiceClient {
89 private static isCodeSuccessful;
90 private static buildUrl;
91 private static interpolateParams;
92 private static buildQueryString;
93 /**
94 * ApiConfiguration instance to provide dependencies for this service client
95 */
96 protected apiConfiguration: ApiConfiguration;
97 private requestInterceptors;
98 private responseInterceptors;
99 /**
100 * Creates new instance of the BaseServiceClient
101 * @param {ApiConfiguration} apiConfiguration configuration parameter to provide dependencies to service client instance
102 */
103 protected constructor(apiConfiguration: ApiConfiguration);
104 /**
105 * Sets array of functions that is going to be executed before the request is send
106 * @param {Function} requestInterceptor request interceptor function
107 * @returns {BaseServiceClient}
108 */
109 withRequestInterceptors(...requestInterceptors: Array<(request: ApiClientRequest) => void | Promise<void>>): BaseServiceClient;
110 /**
111 * Sets array of functions that is going to be executed after the request is send
112 * @param {Function} responseInterceptor response interceptor function
113 * @returns {BaseServiceClient}
114 */
115 withResponseInterceptors(...responseInterceptors: Array<(response: ApiClientResponse) => void | Promise<void>>): BaseServiceClient;
116 /**
117 * Invocation wrapper to implement service operations in generated classes
118 * @param method HTTP method, such as 'POST', 'GET', 'DELETE', etc.
119 * @param endpoint base API url
120 * @param path the path pattern with possible placeholders for path parameters in form {paramName}
121 * @param pathParams path parameters collection
122 * @param queryParams query parameters collection
123 * @param headerParams headers collection
124 * @param bodyParam if body parameter is present it is provided here, otherwise null or undefined
125 * @param errors maps recognized status codes to messages
126 * @param nonJsonBody if the body is in JSON format
127 */
128 protected invoke(method: string, endpoint: string, path: string, pathParams: Map<string, string>, queryParams: Array<{
129 key: string;
130 value: string;
131 }>, headerParams: Array<{
132 key: string;
133 value: string;
134 }>, bodyParam: any, errors: Map<number, string>, nonJsonBody?: boolean): Promise<any>;
135 }
136 /**
137 * Represents a Login With Amazon(LWA) access token
138 */
139 interface AccessToken {
140 token: string;
141 expiry: Number;
142 }
143 /**
144 * Represents a request for retrieving a Login With Amazon(LWA) access token
145 */
146 interface AccessTokenRequest {
147 clientId: string;
148 clientSecret: string;
149 scope?: string;
150 refreshToken?: string;
151 }
152 /**
153 * Represents a response returned by LWA containing a Login With Amazon(LWA) access token
154 */
155 interface AccessTokenResponse {
156 access_token: string;
157 expires_in: number;
158 scope: string;
159 token_type: string;
160 }
161 /**
162 * Represents the authentication configuration for a client ID and client secret
163 */
164 interface AuthenticationConfiguration {
165 clientId: string;
166 clientSecret: string;
167 refreshToken?: string;
168 authEndpoint?: string;
169 }
170 /**
171 * Class to be used to call Amazon LWA to retrieve access tokens.
172 */
173 class LwaServiceClient extends BaseServiceClient {
174 protected static EXPIRY_OFFSET_MILLIS: number;
175 protected static REFRESH_ACCESS_TOKEN: string;
176 protected static CLIENT_CREDENTIALS_GRANT_TYPE: string;
177 protected static LWA_CREDENTIALS_GRANT_TYPE: string;
178 protected static AUTH_ENDPOINT: string;
179 protected authenticationConfiguration: AuthenticationConfiguration;
180 protected tokenStore: {
181 [cacheKey: string]: AccessToken;
182 };
183 protected grantType: string;
184 constructor(options: {
185 apiConfiguration: ApiConfiguration;
186 authenticationConfiguration: AuthenticationConfiguration;
187 grantType?: string;
188 });
189 getAccessTokenForScope(scope: string): Promise<string>;
190 getAccessToken(scope?: string): Promise<string>;
191 protected generateAccessToken(accessTokenRequest: AccessTokenRequest): Promise<AccessTokenResponse>;
192 }
193}
194/**
195 * function creating an AskSdk user agent.
196 * @param packageVersion
197 * @param customUserAgent
198 */
199export declare function createUserAgent(packageVersion: string, customUserAgent: string): string;
200/**
201 * An object containing an application ID. This is used to verify that the request was intended for your service.
202 * @interface
203 */
204export interface Application {
205 /**
206 * A string representing the application identifier for your skill.
207 */
208 'applicationId': string;
209}
210/**
211 * Describes the type of the Cause.
212 * @interface
213 */
214export declare type Cause = ConnectionCompleted;
215/**
216 *
217 * @interface
218 */
219export interface Context {
220 /**
221 * Provides information about the current state of the Alexa service and the device interacting with your skill.
222 */
223 'System': interfaces.system.SystemState;
224 /**
225 * Provides the current state for the Alexa.Presentation interface.
226 */
227 'Alexa.Presentation'?: interfaces.alexa.presentation.PresentationState;
228 /**
229 * Provides the current state for the Alexa.Presentation.APL interface.
230 */
231 'Alexa.Presentation.APL'?: interfaces.alexa.presentation.apl.RenderedDocumentState;
232 /**
233 * Provides the current state for the AudioPlayer interface.
234 */
235 'AudioPlayer'?: interfaces.audioplayer.AudioPlayerState;
236 /**
237 * Provides the automotive specific information of the device.
238 */
239 'Automotive'?: interfaces.automotive.AutomotiveState;
240 /**
241 * Provides the current state for the Display interface.
242 */
243 'Display'?: interfaces.display.DisplayState;
244 /**
245 * Provides the last gathered geolocation information of the device.
246 */
247 'Geolocation'?: interfaces.geolocation.GeolocationState;
248 /**
249 * Provides the characteristics of a device's viewport.
250 */
251 'Viewport'?: interfaces.viewport.ViewportState;
252 /**
253 * This object contains a list of viewports characteristics related to the device's viewports.
254 */
255 'Viewports'?: Array<interfaces.viewport.TypedViewportState>;
256 /**
257 * Provides the current state for Extensions interface
258 */
259 'Extensions'?: interfaces.alexa.extension.ExtensionsState;
260 /**
261 * Provides the current state for the Alexa.DataStore.PackageManager interface.
262 */
263 'Alexa.DataStore.PackageManager'?: interfaces.alexa.datastore.packagemanager.PackageManagerState;
264 /**
265 * Provides the current state for app link capability.
266 */
267 'AppLink'?: interfaces.applink.AppLinkState;
268 /**
269 * Provides the current experimentation state
270 */
271 'Experimentation'?: interfaces.alexa.experimentation.ExperimentationState;
272}
273/**
274 * An object providing information about the device used to send the request. The device object contains both deviceId and supportedInterfaces properties. The deviceId property uniquely identifies the device. The supportedInterfaces property lists each interface that the device supports. For example, if supportedInterfaces includes AudioPlayer {}, then you know that the device supports streaming audio using the AudioPlayer interface.
275 * @interface
276 */
277export interface Device {
278 /**
279 * The deviceId property uniquely identifies the device. This identifier is scoped to a skill. Normally, disabling and re-enabling a skill generates a new identifier.
280 */
281 'deviceId': string;
282 /**
283 * A persistent identifier for the Endpoint ID where the skill request is issued from. An endpoint represents an Alexa-connected Endpoint (like an Echo device, or an application) with which an Alexa customer can interact rather than a physical device, so it could represent applications on your fire TV or your Alexa phone app. The persistentEndpointId is a string that represents a unique identifier for the endpoint in the context of a request. It is in the Amazon Common Identifier format \"amzn1.alexa.endpoint.did.{id}\". This identifier space is scoped to a vendor, therefore it will stay the same regardless of skill enablement.
284 */
285 'persistentEndpointId'?: string;
286 /**
287 * Lists each interface that the device supports. For example, if supportedInterfaces includes AudioPlayer {}, then you know that the device supports streaming audio using the AudioPlayer interface
288 */
289 'supportedInterfaces': SupportedInterfaces;
290}
291/**
292 * Enumeration indicating the status of the multi-turn dialog. This property is included if the skill meets the requirements to use the Dialog directives. Note that COMPLETED is only possible when you use the Dialog.Delegate directive. If you use intent confirmation, dialogState is considered COMPLETED if the user denies the entire intent (for instance, by answering “no” when asked the confirmation prompt). Be sure to also check the confirmationStatus property on the Intent object before fulfilling the user’s request.
293 * @enum
294 */
295export declare type DialogState = 'STARTED' | 'IN_PROGRESS' | 'COMPLETED';
296/**
297 *
298 * @interface
299 */
300export declare type Directive = interfaces.customInterfaceController.StopEventHandlerDirective | interfaces.navigation.assistance.AnnounceRoadRegulation | interfaces.connections.SendRequestDirective | dialog.DynamicEntitiesDirective | interfaces.customInterfaceController.StartEventHandlerDirective | interfaces.gadgetController.SetLightDirective | interfaces.alexa.presentation.apl.SendIndexListDataDirective | dialog.DelegateDirective | dialog.ConfirmIntentDirective | interfaces.alexa.advertisement.InjectAds | interfaces.customInterfaceController.SendDirectiveDirective | interfaces.alexa.presentation.html.HandleMessageDirective | interfaces.alexa.presentation.apla.RenderDocumentDirective | dialog.ElicitSlotDirective | interfaces.alexa.presentation.html.StartDirective | interfaces.alexa.smartvision.snapshotprovider.GetSnapshotDirective | interfaces.audioplayer.StopDirective | dialog.ConfirmSlotDirective | interfaces.audioplayer.PlayDirective | interfaces.alexa.presentation.apl.ExecuteCommandsDirective | interfaces.display.RenderTemplateDirective | interfaces.conversations.ResetContextDirective | dialog.DelegateRequestDirective | interfaces.display.HintDirective | interfaces.connections.V1.StartConnectionDirective | interfaces.alexa.presentation.aplt.RenderDocumentDirective | interfaces.gameEngine.StartInputHandlerDirective | interfaces.videoapp.LaunchDirective | interfaces.alexa.presentation.aplt.ExecuteCommandsDirective | interfaces.gameEngine.StopInputHandlerDirective | interfaces.tasks.CompleteTaskDirective | interfaces.alexa.presentation.apl.RenderDocumentDirective | interfaces.connections.SendResponseDirective | interfaces.alexa.presentation.apl.SendTokenListDataDirective | interfaces.audioplayer.ClearQueueDirective | interfaces.alexa.presentation.apl.UpdateIndexListDataDirective;
301/**
302 * An object that represents what the user wants.
303 * @interface
304 */
305export interface Intent {
306 /**
307 * A string representing the name of the intent.
308 */
309 'name': string;
310 /**
311 * A map of key-value pairs that further describes what the user meant based on a predefined intent schema. The map can be empty.
312 */
313 'slots'?: {
314 [key: string]: Slot;
315 };
316 'confirmationStatus': IntentConfirmationStatus;
317}
318/**
319 * Indication of whether an intent or slot has been explicitly confirmed or denied by the user, or neither.
320 * @enum
321 */
322export declare type IntentConfirmationStatus = 'NONE' | 'DENIED' | 'CONFIRMED';
323/**
324 * This denotes the status of the permission scope.
325 * @enum
326 */
327export declare type PermissionStatus = 'GRANTED' | 'DENIED';
328/**
329 * Contains a consentToken allowing the skill access to information that the customer has consented to provide, such as address information. Note that the consentToken is deprecated. Use the apiAccessToken available in the context object to determine the user’s permissions.
330 * @interface
331 */
332export interface Permissions {
333 /**
334 * A token listing all the permissions granted for this user.
335 */
336 'consentToken'?: string;
337 /**
338 * A map where the key is a LoginWithAmazon(LWA) scope and value is a list of key:value pairs which describe the state of user actions on the LWA scope. For e.g. \"scopes\" :{ \"alexa::devices:all:geolocation:read\":{\"status\":\"GRANTED\"}} This value of \"alexa::devices:all:geolocation:read\" will determine if the Geolocation data access is granted by the user, or else it will show a card of type AskForPermissionsConsent to the user to get this permission.
339 */
340 'scopes'?: {
341 [key: string]: Scope;
342 };
343}
344/**
345 * An object that describes the user (person) who is interacting with Alexa.
346 * @interface
347 */
348export interface Person {
349 /**
350 * A string that represents a unique identifier for the person who is interacting with Alexa. The length of this identifier can vary, but is never more than 255 characters. It is generated when a recognized user makes a request to your skill.
351 */
352 'personId'?: string;
353 /**
354 * A token identifying the user in another system. This is only provided if the recognized user has successfully linked their skill account with their Alexa profile. The accessToken field will not appear if null.
355 */
356 'accessToken'?: string;
357}
358/**
359 * A request object that provides the details of the user’s request. The request body contains the parameters necessary for the service to perform its logic and generate a response.
360 * @interface
361 */
362export declare type Request = interfaces.alexa.advertisement.AdNotRendered | interfaces.alexa.datastore.packagemanager.InstallationError | events.skillevents.SkillEnabledRequest | services.listManagement.ListUpdatedEventRequest | interfaces.alexa.presentation.apl.UserEvent | events.skillevents.SkillDisabledRequest | services.listManagement.ListItemsCreatedEventRequest | SessionResumedRequest | SessionEndedRequest | interfaces.alexa.presentation.apl.LoadIndexListDataEvent | interfaces.alexa.presentation.apl.LoadTokenListDataEvent | interfaces.audioplayer.PlaybackFailedRequest | canfulfill.CanFulfillIntentRequest | interfaces.customInterfaceController.ExpiredRequest | interfaces.alexa.presentation.html.MessageRequest | interfaces.alexa.datastore.DataStoreError | LaunchRequest | authorization.AuthorizationGrantRequest | services.reminderManagement.ReminderCreatedEventRequest | interfaces.alexa.presentation.aplt.UserEvent | interfaces.alexa.advertisement.ReadyToEnqueueAudio | services.listManagement.ListItemsUpdatedEventRequest | services.listManagement.ListCreatedEventRequest | interfaces.audioplayer.PlaybackStartedRequest | interfaces.audioplayer.PlaybackNearlyFinishedRequest | interfaces.customInterfaceController.EventsReceivedRequest | services.reminderManagement.ReminderStatusChangedEventRequest | services.listManagement.ListItemsDeletedEventRequest | services.reminderManagement.ReminderDeletedEventRequest | interfaces.connections.ConnectionsResponse | services.listManagement.ListDeletedEventRequest | interfaces.gameEngine.InputHandlerEventRequest | interfaces.playbackcontroller.PauseCommandIssuedRequest | interfaces.playbackcontroller.PlayCommandIssuedRequest | interfaces.audioplayer.PlaybackFinishedRequest | events.skillevents.ProactiveSubscriptionChangedRequest | interfaces.display.ElementSelectedRequest | events.skillevents.PermissionChangedRequest | services.reminderManagement.ReminderUpdatedEventRequest | interfaces.alexa.advertisement.AdCompleted | interfaces.alexa.datastore.packagemanager.UpdateRequest | interfaces.alexa.presentation.apl.RuntimeErrorEvent | interfaces.alexa.presentation.html.RuntimeErrorRequest | dialog.InputRequest | IntentRequest | interfaces.alexa.datastore.packagemanager.UsagesRemoved | events.skillevents.NotificationSubscriptionChangedRequest | interfaces.conversations.APIInvocationRequest | services.reminderManagement.ReminderStartedEventRequest | interfaces.audioplayer.PlaybackStoppedRequest | interfaces.playbackcontroller.PreviousCommandIssuedRequest | interfaces.alexa.datastore.packagemanager.UsagesInstalled | events.skillevents.AccountLinkedRequest | interfaces.messaging.MessageReceivedRequest | interfaces.connections.ConnectionsRequest | interfaces.system.ExceptionEncounteredRequest | events.skillevents.PermissionAcceptedRequest | interfaces.playbackcontroller.NextCommandIssuedRequest | interfaces.alexa.presentation.apla.RuntimeErrorEvent;
363/**
364 * Request wrapper for all requests sent to your Skill.
365 * @interface
366 */
367export interface RequestEnvelope {
368 /**
369 * The version specifier for the request.
370 */
371 'version': string;
372 /**
373 * The session object provides additional context associated with the request.
374 */
375 'session'?: Session;
376 /**
377 * The context object provides your skill with information about the current state of the Alexa service and device at the time the request is sent to your service. This is included on all requests. For requests sent in the context of a session (LaunchRequest and IntentRequest), the context object duplicates the user and application information that is also available in the session.
378 */
379 'context': Context;
380 /**
381 * A request object that provides the details of the user’s request.
382 */
383 'request': Request;
384}
385/**
386 *
387 * @interface
388 */
389export interface Response {
390 'outputSpeech'?: ui.OutputSpeech;
391 'card'?: ui.Card;
392 'reprompt'?: ui.Reprompt;
393 'directives'?: Array<Directive>;
394 /**
395 * API response object containing API response value(s)
396 */
397 'apiResponse'?: any;
398 'shouldEndSession'?: boolean;
399 'canFulfillIntent'?: canfulfill.CanFulfillIntent;
400 /**
401 * Experiment trigger response from skill
402 */
403 'experimentation'?: interfaces.alexa.experimentation.ExperimentTriggerResponse;
404}
405/**
406 *
407 * @interface
408 */
409export interface ResponseEnvelope {
410 'version': string;
411 'sessionAttributes'?: {
412 [key: string]: any;
413 };
414 'userAgent'?: string;
415 'response': Response;
416}
417/**
418 * This is the value of LoginWithAmazon(LWA) consent scope. This object is used as in the key-value pairs that are provided in user.permissions.scopes object
419 * @interface
420 */
421export interface Scope {
422 'status'?: PermissionStatus;
423}
424/**
425 * Represents a single execution of the alexa service
426 * @interface
427 */
428export interface Session {
429 /**
430 * A boolean value indicating whether this is a new session. Returns true for a new session or false for an existing session.
431 */
432 'new': boolean;
433 /**
434 * A string that represents a unique identifier per a user’s active session.
435 */
436 'sessionId': string;
437 /**
438 * An object that describes the user making the request.
439 */
440 'user': User;
441 /**
442 * A map of key-value pairs. The attributes map is empty for requests where a new session has started with the property new set to true. When returning your response, you can include data you need to persist during the session in the sessionAttributes property. The attributes you provide are then passed back to your skill on the next request.
443 */
444 'attributes'?: {
445 [key: string]: any;
446 };
447 'application': Application;
448}
449/**
450 * An error object providing more information about the error that occurred.
451 * @interface
452 */
453export interface SessionEndedError {
454 /**
455 * A string indicating the type of error that occurred.
456 */
457 'type': SessionEndedErrorType;
458 /**
459 * A string providing more information about the error.
460 */
461 'message': string;
462}
463/**
464 * A string indicating the type of error that occurred.
465 * @enum
466 */
467export declare type SessionEndedErrorType = 'INVALID_RESPONSE' | 'DEVICE_COMMUNICATION_ERROR' | 'INTERNAL_SERVICE_ERROR' | 'ENDPOINT_TIMEOUT';
468/**
469 * The reason why session ended when not initiated from the Skill itself.
470 * @enum
471 */
472export declare type SessionEndedReason = 'USER_INITIATED' | 'ERROR' | 'EXCEEDED_MAX_REPROMPTS';
473/**
474 *
475 * @interface
476 */
477export interface Slot {
478 /**
479 * A string that represents the name of the slot.
480 */
481 'name': string;
482 /**
483 * A string that represents the value the user spoke for the slot. This is the actual value the user spoke, not necessarily the canonical value or one of the synonyms defined for the entity. Note that AMAZON.LITERAL slot values sent to your service are always in all lower case.
484 */
485 'value'?: string;
486 /**
487 * Indication of whether an intent or slot has been explicitly confirmed or denied by the user, or neither.
488 */
489 'confirmationStatus': SlotConfirmationStatus;
490 /**
491 * Contains the resultsof entity resolution. These are organized by authority. An authority represents the source for the data provided for the slot. For a custom slot type, the authority is the slot type you defined.
492 */
493 'resolutions'?: slu.entityresolution.Resolutions;
494 /**
495 * Object representing the value of the slot.
496 */
497 'slotValue'?: SlotValue;
498}
499/**
500 * An enumeration indicating whether the user has explicitly confirmed or denied the value of this slot.
501 * @enum
502 */
503export declare type SlotConfirmationStatus = 'NONE' | 'DENIED' | 'CONFIRMED';
504/**
505 * Object representing the value captured in the slot.
506 * @interface
507 */
508export declare type SlotValue = ListSlotValue | SimpleSlotValue;
509/**
510 * Status indicates a high level understanding of the result of an execution.
511 * @interface
512 */
513export interface Status {
514 /**
515 * This is a code signifying the status of the execution initiated by the skill. Protocol adheres to HTTP status codes.
516 */
517 'code': string;
518 /**
519 * This is a message that goes along with response code that can provide more information about what occurred.
520 */
521 'message': string;
522}
523/**
524 * An object listing each interface that the device supports. For example, if supportedInterfaces includes AudioPlayer {}, then you know that the device supports streaming audio using the AudioPlayer interface.
525 * @interface
526 */
527export interface SupportedInterfaces {
528 'Alexa.Advertisement'?: interfaces.alexa.advertisement.AlexaAdvertisementInterface;
529 'Alexa.Presentation.APL'?: interfaces.alexa.presentation.apl.AlexaPresentationAplInterface;
530 'Alexa.Presentation.APLT'?: interfaces.alexa.presentation.aplt.AlexaPresentationApltInterface;
531 'Alexa.Presentation.HTML'?: interfaces.alexa.presentation.html.AlexaPresentationHtmlInterface;
532 'AppLink'?: interfaces.applink.AppLinkInterface;
533 'AudioPlayer'?: interfaces.audioplayer.AudioPlayerInterface;
534 'Display'?: interfaces.display.DisplayInterface;
535 'VideoApp'?: interfaces.videoapp.VideoAppInterface;
536 'Geolocation'?: interfaces.geolocation.GeolocationInterface;
537 'Navigation'?: interfaces.navigation.NavigationInterface;
538}
539/**
540 * This object encapsulates a specific functionality.
541 * @interface
542 */
543export interface Task {
544 /**
545 * Represents the name of the task.
546 */
547 'name': string;
548 /**
549 * Represents the version of the task.
550 */
551 'version': string;
552 /**
553 * Represents the input to handle the task.
554 */
555 'input'?: any;
556}
557/**
558 * An object that describes the Amazon account for which the skill is enabled.
559 * @interface
560 */
561export interface User {
562 /**
563 * A string that represents a unique identifier for the user who made the request. The length of this identifier can vary, but is never more than 255 characters. The userId is automatically generated when a user enables the skill in the Alexa app. Note: Disabling and re-enabling a skill generates a new identifier.
564 */
565 'userId': string;
566 /**
567 * A token identifying the user in another system. This is only provided if the user has successfully linked their skill account with their Amazon account.
568 */
569 'accessToken'?: string;
570 'permissions'?: Permissions;
571}
572export declare namespace authorization {
573 /**
574 * Authorization grant body.
575 * @interface
576 */
577 interface AuthorizationGrantBody {
578 'grant': authorization.Grant;
579 }
580}
581export declare namespace authorization {
582 /**
583 * Information that identifies a user in Amazon Alexa systems.
584 * @interface
585 */
586 interface Grant {
587 /**
588 * Type of the grant.
589 */
590 'type': authorization.GrantType;
591 /**
592 * The authorization code for the user.
593 */
594 'code': string;
595 }
596}
597export declare namespace authorization {
598 /**
599 * One of the grant types supported.
600 * @enum
601 */
602 type GrantType = 'OAuth2.AuthorizationCode';
603}
604export declare namespace canfulfill {
605 /**
606 * CanFulfillIntent represents the response to canFulfillIntentRequest includes the details about whether the skill can understand and fulfill the intent request with detected slots.
607 * @interface
608 */
609 interface CanFulfillIntent {
610 'canFulfill': canfulfill.CanFulfillIntentValues;
611 /**
612 * A map that represents skill's detailed response to each detected slot within the intent such as if skill can understand and fulfill the detected slot. This supplements the overall canFulfillIntent response and help Alexa make better ranking and arbitration decisions. The key is the name of the slot. The value is an object of type CanFulfillSlot.
613 */
614 'slots'?: {
615 [key: string]: canfulfill.CanFulfillSlot;
616 };
617 }
618}
619export declare namespace canfulfill {
620 /**
621 * Overall if skill can understand and fulfill the intent with detected slots. Respond YES when skill understands all slots, can fulfill all slots, and can fulfill the request in its entirety. Respond NO when skill either cannot understand the intent, cannot understand all the slots, or cannot fulfill all the slots. Respond MAYBE when skill can understand the intent, can partially or fully understand the slots, and can partially or fully fulfill the slots. The only cases where should respond MAYBE is when skill partially understand the request and can potentially complete the request if skill get more data, either through callbacks or through a multi-turn conversation with the user.
622 * @enum
623 */
624 type CanFulfillIntentValues = 'YES' | 'NO' | 'MAYBE';
625}
626export declare namespace canfulfill {
627 /**
628 * This represents skill's capability to understand and fulfill each detected slot.
629 * @interface
630 */
631 interface CanFulfillSlot {
632 'canUnderstand': canfulfill.CanUnderstandSlotValues;
633 'canFulfill'?: canfulfill.CanFulfillSlotValues;
634 }
635}
636export declare namespace canfulfill {
637 /**
638 * This field indicates whether skill can fulfill relevant action for the slot, that has been partially or fully understood. The definition of fulfilling the slot is dependent on skill and skill is required to have logic in place to determine whether a slot value can be fulfilled in the context of skill or not. Return YES if Skill can certainly fulfill the relevant action for this slot value. Return NO if skill cannot fulfill the relevant action for this slot value. For specific recommendations to set the value refer to the developer docs for more details.
639 * @enum
640 */
641 type CanFulfillSlotValues = 'YES' | 'NO';
642}
643export declare namespace canfulfill {
644 /**
645 * This field indicates whether skill has understood the slot value. In most typical cases, skills will do some form of entity resolution by looking up a catalog or list to determine whether they recognize the slot or not. Return YES if skill have a perfect match or high confidence match (for eg. synonyms) with catalog or list maintained by skill. Return NO if skill cannot understand or recognize the slot value. Return MAYBE if skill have partial confidence or partial match. This will be true when the slot value doesn’t exist as is, in the catalog, but a variation or a fuzzy match may exist. For specific recommendations to set the value refer to the developer docs for more details.
646 * @enum
647 */
648 type CanUnderstandSlotValues = 'YES' | 'NO' | 'MAYBE';
649}
650export declare namespace dialog {
651 /**
652 * The delegation period.
653 * @interface
654 */
655 interface DelegationPeriod {
656 'until'?: dialog.DelegationPeriodUntil;
657 }
658}
659export declare namespace dialog {
660 /**
661 * The end of the specified delegation period. * EXPLICIT_RETURN - delegation lasts until the targeted dialog manager returns a delegate with a new target. * NEXT_TURN - delegation lasts until the next turn, which resumes with the current focused dialog manager.
662 * @enum
663 */
664 type DelegationPeriodUntil = 'EXPLICIT_RETURN' | 'NEXT_TURN';
665}
666export declare namespace dialog {
667 /**
668 * Structured input data to send to a dialog manager. Currently, this is an Alexa Conversations input instance.
669 * @interface
670 */
671 interface Input {
672 /**
673 * The Alexa Conversations input name as dictated in the Conversations model.
674 */
675 'name': string;
676 /**
677 * A map of input slots by slot name.
678 */
679 'slots'?: {
680 [key: string]: Slot;
681 };
682 }
683}
684export declare namespace dialog {
685 /**
686 * The updated request to delegate. Null will delegate the current request.
687 * @interface
688 */
689 type UpdatedRequest = dialog.UpdatedInputRequest | dialog.UpdatedIntentRequest;
690}
691export declare namespace dynamicEndpoints {
692 /**
693 * Base response type.
694 * @interface
695 */
696 type BaseResponse = dynamicEndpoints.FailureResponse | dynamicEndpoints.SuccessResponse;
697}
698export declare namespace dynamicEndpoints {
699 /**
700 * Request from a Dynamic endpoint connection.
701 * @interface
702 */
703 interface Request {
704 /**
705 * The version of the request message schema used.
706 */
707 'version': string;
708 /**
709 * Denotes type of request.
710 */
711 'type': string;
712 /**
713 * The requestId for the dynamic endpoint request.
714 */
715 'requestId': string;
716 /**
717 * The request payload.
718 */
719 'requestPayload': string;
720 }
721}
722export declare namespace er.dynamic {
723 /**
724 * Represents an entity that the skill wants to store. An entity has an optional Id and the value and the synonyms for the entity
725 * @interface
726 */
727 interface Entity {
728 /**
729 * An unique id associated with the entity
730 */
731 'id'?: string;
732 'name': er.dynamic.EntityValueAndSynonyms;
733 }
734}
735export declare namespace er.dynamic {
736 /**
737 * Represents an array of entities of a particular type.
738 * @interface
739 */
740 interface EntityListItem {
741 /**
742 * The entity type. Must match the slot type as defined in the interaction model.
743 */
744 'name': string;
745 /**
746 * A list of dynamic entities which are of the same type
747 */
748 'values': Array<er.dynamic.Entity>;
749 }
750}
751export declare namespace er.dynamic {
752 /**
753 * A container object with value and synomyms for the entity
754 * @interface
755 */
756 interface EntityValueAndSynonyms {
757 /**
758 * The entity value
759 */
760 'value': string;
761 /**
762 * An array of synonyms for the entity
763 */
764 'synonyms'?: Array<string>;
765 }
766}
767export declare namespace er.dynamic {
768 /**
769 * Replace the existing dynamic entities or clear them from the catalog
770 * @enum
771 */
772 type UpdateBehavior = 'REPLACE' | 'CLEAR';
773}
774export declare namespace events.skillevents {
775 /**
776 *
777 * @interface
778 */
779 interface AccountLinkedBody {
780 'accessToken'?: string;
781 }
782}
783export declare namespace events.skillevents {
784 /**
785 *
786 * @interface
787 */
788 interface NotificationSubscriptionChangedBody {
789 /**
790 * The list of to Topics that this user has subscribed/permitted to receive notification from your skill. If a customer unsubscribes for a Topic, this list will contain remaining Topics to which the customer is still subscribed to receive from your skill. If the list of subscriptions is empty, this customer has removed notification subscription for all Topics from your skill.
791 */
792 'subscriptions'?: Array<events.skillevents.NotificationSubscriptionEvent>;
793 }
794}
795export declare namespace events.skillevents {
796 /**
797 *
798 * @interface
799 */
800 interface NotificationSubscriptionEvent {
801 /**
802 * The topicId will be one of the Topics specified in your Skill's manifest file.
803 */
804 'topicId'?: string;
805 }
806}
807export declare namespace events.skillevents {
808 /**
809 *
810 * @interface
811 */
812 interface Permission {
813 /**
814 * The value representing the permission scope.
815 */
816 'scope'?: string;
817 }
818}
819export declare namespace events.skillevents {
820 /**
821 *
822 * @interface
823 */
824 interface PermissionBody {
825 /**
826 * The current list of permissions consented to on the account level. It can be an empty list if there are no account level permissions consented to.
827 */
828 'acceptedPermissions'?: Array<events.skillevents.Permission>;
829 /**
830 * The current list of permissions consented to on the person level. This is only present if the request contains the ```person``` object. It can be an empty list if there are no person level permissions consented to.
831 */
832 'acceptedPersonPermissions'?: Array<events.skillevents.Permission>;
833 }
834}
835export declare namespace events.skillevents {
836 /**
837 *
838 * @interface
839 */
840 interface ProactiveSubscriptionChangedBody {
841 /**
842 * The list of events that this customer is currently subscribed to. If a customer unsubscribes from an event, this list will contain remaining event types to which the customer is still subscribed to receive from your skill. If the list of subscriptions is empty, this customer has unsubscribed from all event types from your skill.
843 */
844 'subscriptions'?: Array<events.skillevents.ProactiveSubscriptionEvent>;
845 }
846}
847export declare namespace events.skillevents {
848 /**
849 *
850 * @interface
851 */
852 interface ProactiveSubscriptionEvent {
853 'eventName'?: string;
854 }
855}
856export declare namespace interfaces.alexa.advertisement {
857 /**
858 * The interface provides skills with the ability to seamlessly integrate advertisements during their interactions with users.
859 * @interface
860 */
861 interface AlexaAdvertisementInterface {
862 }
863}
864export declare namespace interfaces.alexa.advertisement {
865 /**
866 * The object encapsulates information regarding the reasons why the ad is not being rendered.
867 * @interface
868 */
869 interface Reason {
870 /**
871 * The enum represents various details explaining why the ad is not being rendered.
872 */
873 'type'?: interfaces.alexa.advertisement.ReasonCode;
874 /**
875 * The message provides an explanation of the specific details as to why the ad is not being rendered.
876 */
877 'message'?: string;
878 }
879}
880export declare namespace interfaces.alexa.advertisement {
881 /**
882 * The enum represents various details explaining why the ad is not being rendered.
883 * @enum
884 */
885 type ReasonCode = 'DEVICE_OCCUPIED' | 'UNSUPPORTED_DEVICE' | 'SKILL_DAILY_CAP_LIMIT_REACHED' | 'DOMAIN_DAILY_CAP_LIMIT_REACHED' | 'INTERNAL_SERVER_ERROR' | 'AD_NOT_AVAILABLE';
886}
887export declare namespace interfaces.alexa.comms.messagingcontroller {
888 /**
889 * A map whose key is the new status and value is the message ID list. The status of the messages whose IDs are in the list will be updated to the new status from the key.
890 * @interface
891 */
892 interface StatusMap {
893 /**
894 * List of read messages
895 */
896 'read'?: Array<string>;
897 /**
898 * List of deleted messages
899 */
900 'deleted'?: Array<string>;
901 }
902}
903export declare namespace interfaces.alexa.datastore {
904 /**
905 * DataStore error object payload.
906 * @interface
907 */
908 type CommandsError = interfaces.alexa.datastore.DeviceUnavailableError | interfaces.alexa.datastore.DevicePermanantlyUnavailableError | interfaces.alexa.datastore.DataStoreInternalError | interfaces.alexa.datastore.StorageLimitExeceededError;
909}
910export declare namespace interfaces.alexa.datastore {
911 /**
912 * Content of a commands dispatch error.
913 * @interface
914 */
915 interface DispatchErrorContent {
916 /**
917 * Identifier of the device where execution error happens.
918 */
919 'deviceId': string;
920 /**
921 * Commands in the same order of request time so that skill can extend deliver expiry.
922 */
923 'commands': Array<services.datastore.v1.Command>;
924 }
925}
926export declare namespace interfaces.alexa.datastore {
927 /**
928 * Type of error. Modules can also use this event to report global error like permission denied. Supported values [STORAGE_LIMIT_EXCEEDED, PERMISSION_DENIED, VALIDATION_ERROR, DATASTORE_INTERNAL_ERROR]
929 * @interface
930 */
931 interface Error {
932 /**
933 * Type of error. Modules can also use this event to report global error like permission denied
934 */
935 'type': string;
936 /**
937 * Opaque payload which will contain additional details about error.
938 */
939 'content'?: any;
940 }
941}
942export declare namespace interfaces.alexa.datastore {
943 /**
944 * Content of an execution error.
945 * @interface
946 */
947 interface ExecutionErrorContent {
948 /**
949 * Identifier of the device where execution error happens.
950 */
951 'deviceId': string;
952 /**
953 * the command that was not executed successfully because of the error.
954 */
955 'failedCommand': services.datastore.v1.Command;
956 /**
957 * Opaque message describing the error.
958 */
959 'message'?: string;
960 }
961}
962export declare namespace interfaces.alexa.datastore.packagemanager {
963 /**
964 * Interface using which skills communicate with DataStore Package Manager on the device.
965 * @interface
966 */
967 interface AlexaDataStorePackageManagerInterface {
968 }
969}
970export declare namespace interfaces.alexa.datastore.packagemanager {
971 /**
972 * Type of package error. Allowed values are [INTERNAL_ERROR]
973 * @enum
974 */
975 type ErrorType = 'INTERNAL_ERROR';
976}
977export declare namespace interfaces.alexa.datastore.packagemanager {
978 /**
979 * Location where the package can be rendered on the device.
980 * @enum
981 */
982 type Locations = 'FAVORITE';
983}
984export declare namespace interfaces.alexa.datastore.packagemanager {
985 /**
986 * Information of the package that is being installed on the device.
987 * @interface
988 */
989 interface Package {
990 /**
991 * Version of a package manifest schema. Currently supported schema version is 1.0.
992 */
993 'packageVersion': string;
994 }
995}
996export declare namespace interfaces.alexa.datastore.packagemanager {
997 /**
998 * Additional information about the package installation/update error.
999 * @interface
1000 */
1001 interface PackageError {
1002 'type': interfaces.alexa.datastore.packagemanager.ErrorType;
1003 /**
1004 * Opaque payload which will contain additional details about error.
1005 */
1006 'content'?: any;
1007 }
1008}
1009export declare namespace interfaces.alexa.datastore.packagemanager {
1010 /**
1011 * Places where the package is going to be used on the device. This object is passed as part of the InstallRequest to the skill.
1012 * @interface
1013 */
1014 interface PackageInstallUsage {
1015 'location': interfaces.alexa.datastore.packagemanager.Locations;
1016 /**
1017 * Identifier of the instance of the package.
1018 */
1019 'instanceId'?: string;
1020 }
1021}
1022export declare namespace interfaces.alexa.datastore.packagemanager {
1023 /**
1024 * Provides context about the list of packages installed on the device.
1025 * @interface
1026 */
1027 interface PackageManagerState {
1028 /**
1029 * Includes all installed packages on the device.
1030 */
1031 'installedPackages'?: Array<interfaces.alexa.datastore.packagemanager.PackageStateInformation>;
1032 }
1033}
1034export declare namespace interfaces.alexa.datastore.packagemanager {
1035 /**
1036 * Places where the package is going to be not used anymore on the device. This object is passed as part of the PackageRemovedRequest to the skill.
1037 * @interface
1038 */
1039 interface PackageRemoveUsage {
1040 'location': interfaces.alexa.datastore.packagemanager.Locations;
1041 /**
1042 * Identifier of the instance of the package.
1043 */
1044 'instanceId'?: string;
1045 }
1046}
1047export declare namespace interfaces.alexa.datastore.packagemanager {
1048 /**
1049 * State information of the DataStore package version installed on the device.
1050 * @interface
1051 */
1052 interface PackageStateInformation {
1053 /**
1054 * Unique package identifier for a client.
1055 */
1056 'packageId': string;
1057 /**
1058 * Unique version of a package.
1059 */
1060 'version': string;
1061 }
1062}
1063export declare namespace interfaces.alexa.datastore.packagemanager {
1064 /**
1065 * Information about the package that is going to be installed on the device and also where its going to be used on the device.
1066 * @interface
1067 */
1068 interface UsagesInstallRequest {
1069 /**
1070 * Unique package identifier for a client.
1071 */
1072 'packageId': string;
1073 /**
1074 * Version of a package being installed on the device.
1075 */
1076 'packageVersion': string;
1077 /**
1078 * Areas where package is going to be used on the device.
1079 */
1080 'usages': Array<interfaces.alexa.datastore.packagemanager.PackageInstallUsage>;
1081 }
1082}
1083export declare namespace interfaces.alexa.datastore.packagemanager {
1084 /**
1085 * Information about where the package has been removed and where its not being used anymore.
1086 * @interface
1087 */
1088 interface UsagesRemovedRequest {
1089 /**
1090 * Unique package identifier for a client.
1091 */
1092 'packageId': string;
1093 /**
1094 * Version of a package being removed from the device.
1095 */
1096 'packageVersion': string;
1097 /**
1098 * Areas where package is going to be not used on the device.
1099 */
1100 'usages': Array<interfaces.alexa.datastore.packagemanager.PackageRemoveUsage>;
1101 }
1102}
1103export declare namespace interfaces.alexa.experimentation {
1104 /**
1105 * Represents the state of an active experiment's assignment
1106 * @interface
1107 */
1108 interface ExperimentAssignment {
1109 'id'?: string;
1110 'treatmentId'?: interfaces.alexa.experimentation.TreatmentId;
1111 }
1112}
1113export declare namespace interfaces.alexa.experimentation {
1114 /**
1115 * Experiment trigger response from skill
1116 * @interface
1117 */
1118 interface ExperimentTriggerResponse {
1119 /**
1120 * Contains array of triggered experiment ids
1121 */
1122 'triggeredExperiments'?: Array<string>;
1123 }
1124}
1125export declare namespace interfaces.alexa.experimentation {
1126 /**
1127 *
1128 * @interface
1129 */
1130 interface ExperimentationState {
1131 'activeExperiments'?: Array<interfaces.alexa.experimentation.ExperimentAssignment>;
1132 }
1133}
1134export declare namespace interfaces.alexa.experimentation {
1135 /**
1136 * Experiment treatment identifier
1137 * @enum
1138 */
1139 type TreatmentId = 'C' | 'T1';
1140}
1141export declare namespace interfaces.alexa.extension {
1142 /**
1143 * This object describes an extension that skill can request at runtime.
1144 * @interface
1145 */
1146 interface AvailableExtension {
1147 }
1148}
1149export declare namespace interfaces.alexa.extension {
1150 /**
1151 *
1152 * @interface
1153 */
1154 interface ExtensionsState {
1155 /**
1156 * A map from extension URI to extension object where the object space is reserved for providing authorization information or other such data in the future.
1157 */
1158 'available': {
1159 [key: string]: interfaces.alexa.extension.AvailableExtension;
1160 };
1161 }
1162}
1163export declare namespace interfaces.alexa.presentation {
1164 /**
1165 * Provides context about presentations at the time of the request.
1166 * @interface
1167 */
1168 interface PresentationState {
1169 /**
1170 * Includes all presentation contexts owned by the skill which were perceptible at the time of the request.
1171 */
1172 'contexts'?: Array<interfaces.alexa.presentation.PresentationStateContext>;
1173 }
1174}
1175export declare namespace interfaces.alexa.presentation {
1176 /**
1177 *
1178 * @interface
1179 */
1180 type PresentationStateContext = interfaces.alexa.presentation.AplPresentationStateContext;
1181}
1182export declare namespace interfaces.alexa.presentation.apl {
1183 /**
1184 *
1185 * @interface
1186 */
1187 interface AlexaPresentationAplInterface {
1188 'runtime'?: interfaces.alexa.presentation.apl.Runtime;
1189 }
1190}
1191export declare namespace interfaces.alexa.presentation.apl {
1192 /**
1193 * The alignment of the item after scrolling. Defaults to visible.
1194 * @enum
1195 */
1196 type Align = 'center' | 'first' | 'last' | 'visible';
1197}
1198export declare namespace interfaces.alexa.presentation.apl {
1199 /**
1200 * How repeated animations will play.
1201 * @enum
1202 */
1203 type AnimateItemRepeatMode = 'restart' | 'reverse';
1204}
1205export declare namespace interfaces.alexa.presentation.apl {
1206 /**
1207 *
1208 * @interface
1209 */
1210 type AnimatedProperty = interfaces.alexa.presentation.apl.AnimatedOpacityProperty | interfaces.alexa.presentation.apl.AnimatedTransformProperty;
1211}
1212export declare namespace interfaces.alexa.presentation.apl {
1213 /**
1214 * The audio track to play on. Defaults to “foreground”
1215 * @enum
1216 */
1217 type AudioTrack = 'foreground' | 'background' | 'none';
1218}
1219export declare namespace interfaces.alexa.presentation.apl {
1220 /**
1221 * The type of back navigation to use. Defaults to count.
1222 * @enum
1223 */
1224 type BackType = 'count' | 'index' | 'id';
1225}
1226export declare namespace interfaces.alexa.presentation.apl {
1227 /**
1228 * A message that can change the visual or audio presentation of the content on the screen.
1229 * @interface
1230 */
1231 type Command = interfaces.alexa.presentation.apl.SetPageCommand | interfaces.alexa.presentation.apl.ControlMediaCommand | interfaces.alexa.presentation.apl.FinishCommand | interfaces.alexa.presentation.apl.AutoPageCommand | interfaces.alexa.presentation.apl.PlayMediaCommand | interfaces.alexa.presentation.apl.GoBackCommand | interfaces.alexa.presentation.apl.ScrollCommand | interfaces.alexa.presentation.apl.IdleCommand | interfaces.alexa.presentation.apl.AnimateItemCommand | interfaces.alexa.presentation.apl.SendEventCommand | interfaces.alexa.presentation.apl.ShowOverlayCommand | interfaces.alexa.presentation.apl.SpeakListCommand | interfaces.alexa.presentation.apl.SelectCommand | interfaces.alexa.presentation.apl.HideOverlayCommand | interfaces.alexa.presentation.apl.SequentialCommand | interfaces.alexa.presentation.apl.SetStateCommand | interfaces.alexa.presentation.apl.SpeakItemCommand | interfaces.alexa.presentation.apl.ParallelCommand | interfaces.alexa.presentation.apl.OpenUrlCommand | interfaces.alexa.presentation.apl.ReinflateCommand | interfaces.alexa.presentation.apl.ClearFocusCommand | interfaces.alexa.presentation.apl.ScrollToIndexCommand | interfaces.alexa.presentation.apl.SetValueCommand | interfaces.alexa.presentation.apl.SetFocusCommand | interfaces.alexa.presentation.apl.ScrollToComponentCommand;
1232}
1233export declare namespace interfaces.alexa.presentation.apl {
1234 /**
1235 * The entity context data which was attached to an element.
1236 * @interface
1237 */
1238 interface ComponentEntity {
1239 'type'?: string;
1240 'value'?: string;
1241 'id'?: string;
1242 }
1243}
1244export declare namespace interfaces.alexa.presentation.apl {
1245 /**
1246 * Component state.
1247 * @enum
1248 */
1249 type ComponentState = 'checked' | 'disabled' | 'focused';
1250}
1251export declare namespace interfaces.alexa.presentation.apl {
1252 /**
1253 * Definition of a visible APL element shown on screen.
1254 * @interface
1255 */
1256 interface ComponentVisibleOnScreen {
1257 /**
1258 * All child elements of the displayed element.
1259 */
1260 'children'?: Array<interfaces.alexa.presentation.apl.ComponentVisibleOnScreen>;
1261 /**
1262 * The entities which were attached to the element.
1263 */
1264 'entities'?: Array<interfaces.alexa.presentation.apl.ComponentEntity>;
1265 /**
1266 * The id of the element.
1267 */
1268 'id': string;
1269 /**
1270 * Global position of the element (as seen by the device user).
1271 */
1272 'position': string;
1273 /**
1274 * The tags which were attached to the element.
1275 */
1276 'tags': interfaces.alexa.presentation.apl.ComponentVisibleOnScreenTags;
1277 /**
1278 * The transform which was applied to the element's position, specified as a 6-element numeric array containing the 2D homogeneous transformation matrix. The center of the transformation coordinate system is the center of the component. The transformation array is ordered as [A,B,C,D,Tx,Ty]. For more information refer to the W3C's CSS transforms documentation.
1279 */
1280 'transform'?: Array<number>;
1281 /**
1282 * The visual appearance of the element.
1283 */
1284 'type': string;
1285 /**
1286 * The system-generated uid of the element.
1287 */
1288 'uid': string;
1289 /**
1290 * The relative visibility of the element. 0 = not visible, 1 = fully visible on screen.
1291 */
1292 'visibility'?: number;
1293 }
1294}
1295export declare namespace interfaces.alexa.presentation.apl {
1296 /**
1297 * An element in a scrolling list
1298 * @interface
1299 */
1300 interface ComponentVisibleOnScreenListItemTag {
1301 /**
1302 * The zero-based index of this item in its parent.
1303 */
1304 'index'?: number;
1305 }
1306}
1307export declare namespace interfaces.alexa.presentation.apl {
1308 /**
1309 * An ordered list of items
1310 * @interface
1311 */
1312 interface ComponentVisibleOnScreenListTag {
1313 /**
1314 * The total number of items in the list.
1315 */
1316 'itemCount'?: number;
1317 /**
1318 * The index of the lowest item seen.
1319 */
1320 'lowestIndexSeen'?: number;
1321 /**
1322 * The index of the highest item seen.
1323 */
1324 'highestIndexSeen'?: number;
1325 /**
1326 * The ordinal of the lowest ordinal-equipped item seen.
1327 */
1328 'lowestOrdinalSeen'?: number;
1329 /**
1330 * The ordinal of the highest ordinal-equipped item seen.
1331 */
1332 'highestOrdinalSeen'?: number;
1333 }
1334}
1335export declare namespace interfaces.alexa.presentation.apl {
1336 /**
1337 * Media player
1338 * @interface
1339 */
1340 interface ComponentVisibleOnScreenMediaTag {
1341 /**
1342 * Current position of the play head from the start of the track.
1343 */
1344 'positionInMilliseconds'?: number;
1345 'state'?: interfaces.alexa.presentation.apl.ComponentVisibleOnScreenMediaTagStateEnum;
1346 /**
1347 * Whether the user may seek forward relative to the current position.
1348 */
1349 'allowAdjustSeekPositionForward'?: boolean;
1350 /**
1351 * Whether the user may seek backwards relative to the current position.
1352 */
1353 'allowAdjustSeekPositionBackwards'?: boolean;
1354 /**
1355 * Whether the user may move forward to the next track.
1356 */
1357 'allowNext'?: boolean;
1358 /**
1359 * Whether the user may move backward to the previous track.
1360 */
1361 'allowPrevious'?: boolean;
1362 'entities'?: Array<interfaces.alexa.presentation.apl.ComponentEntity>;
1363 /**
1364 * The URL of the current media track.
1365 */
1366 'url'?: string;
1367 }
1368}
1369export declare namespace interfaces.alexa.presentation.apl {
1370 /**
1371 * Media player stage posible states
1372 * @enum
1373 */
1374 type ComponentVisibleOnScreenMediaTagStateEnum = 'idle' | 'playing' | 'paused';
1375}
1376export declare namespace interfaces.alexa.presentation.apl {
1377 /**
1378 * A collection of items that are displayed one at a time.
1379 * @interface
1380 */
1381 interface ComponentVisibleOnScreenPagerTag {
1382 /**
1383 * The index of the current page.
1384 */
1385 'index'?: number;
1386 /**
1387 * The total number of pages.
1388 */
1389 'pageCount'?: number;
1390 /**
1391 * Indicates whether the pager will accept a forward command.
1392 */
1393 'allowForward'?: boolean;
1394 /**
1395 * Indicates whether the pager will accept a backward command.
1396 */
1397 'allowBackwards'?: boolean;
1398 }
1399}
1400export declare namespace interfaces.alexa.presentation.apl {
1401 /**
1402 * A scrollable region.
1403 * @interface
1404 */
1405 interface ComponentVisibleOnScreenScrollableTag {
1406 'direction'?: interfaces.alexa.presentation.apl.ComponentVisibleOnScreenScrollableTagDirectionEnum;
1407 /**
1408 * Whether scrolling forward is accepted.
1409 */
1410 'allowForward'?: boolean;
1411 /**
1412 * Whether scrolling backward is accepted.
1413 */
1414 'allowBackward'?: boolean;
1415 }
1416}
1417export declare namespace interfaces.alexa.presentation.apl {
1418 /**
1419 * Scrolling direction
1420 * @enum
1421 */
1422 type ComponentVisibleOnScreenScrollableTagDirectionEnum = 'horizontal' | 'vertical';
1423}
1424export declare namespace interfaces.alexa.presentation.apl {
1425 /**
1426 * The tags which were attached to an element.
1427 * @interface
1428 */
1429 interface ComponentVisibleOnScreenTags {
1430 /**
1431 * The checked state of a component that has two states.
1432 */
1433 'checked'?: boolean;
1434 /**
1435 * A button or item that can be pressed.
1436 */
1437 'clickable'?: boolean;
1438 /**
1439 * Whether the element is disabled.
1440 */
1441 'disabled'?: boolean;
1442 /**
1443 * The focused state of a component that can take focus.
1444 */
1445 'focused'?: boolean;
1446 /**
1447 * An ordered list of items.
1448 */
1449 'list'?: interfaces.alexa.presentation.apl.ComponentVisibleOnScreenListTag;
1450 /**
1451 * An element in a sequence.
1452 */
1453 'listItem'?: interfaces.alexa.presentation.apl.ComponentVisibleOnScreenListItemTag;
1454 /**
1455 * Media player
1456 */
1457 'media'?: interfaces.alexa.presentation.apl.ComponentVisibleOnScreenMediaTag;
1458 /**
1459 * A visibly numbered element.
1460 */
1461 'ordinal'?: number;
1462 /**
1463 * A collection of items that are displayed one at a time.
1464 */
1465 'pager'?: interfaces.alexa.presentation.apl.ComponentVisibleOnScreenPagerTag;
1466 /**
1467 * A scrolling region
1468 */
1469 'scrollable'?: interfaces.alexa.presentation.apl.ComponentVisibleOnScreenScrollableTag;
1470 /**
1471 * A region of the screen that can be read out by TTS
1472 */
1473 'spoken'?: boolean;
1474 /**
1475 * The entire screen in which a document is rendered.
1476 */
1477 'viewport'?: interfaces.alexa.presentation.apl.ComponentVisibleOnScreenViewportTag;
1478 }
1479}
1480export declare namespace interfaces.alexa.presentation.apl {
1481 /**
1482 * The entire screen in which a document is rendered.
1483 * @interface
1484 */
1485 interface ComponentVisibleOnScreenViewportTag {
1486 }
1487}
1488export declare namespace interfaces.alexa.presentation.apl {
1489 /**
1490 * How highlighting is applied: on a line-by-line basis, or to the entire block. Defaults to block.
1491 * @enum
1492 */
1493 type HighlightMode = 'block' | 'line';
1494}
1495export declare namespace interfaces.alexa.presentation.apl {
1496 /**
1497 * The reason for the failure.
1498 * @enum
1499 */
1500 type ListRuntimeErrorReason = 'INVALID_PRESENTATION_TOKEN' | 'INVALID_LIST_ID' | 'INVALID_DATASOURCE' | 'INVALID_OPERATION' | 'MISSING_LIST_VERSION' | 'DUPLICATE_LIST_VERSION' | 'LIST_INDEX_OUT_OF_RANGE' | 'MISSING_LIST_VERSION_IN_SEND_DATA' | 'LOAD_TIMEOUT' | 'INCONSISTENT_LIST_ID' | 'INCONSISTENT_PAGE_TOKEN' | 'INCONSISTENT_PAGE_ITEMS' | 'DUPLICATE_PAGE_TOKEN' | 'OCCUPIED_LIST_INDEX' | 'LOAD_INDEX_OUT_OF_RANGE' | 'INCONSISTENT_RANGE' | 'MISSING_LIST_ITEMS' | 'INTERNAL_ERROR';
1501}
1502export declare namespace interfaces.alexa.presentation.apl {
1503 /**
1504 * The command enumerated value is the operation that should be performed on the media player.
1505 * @enum
1506 */
1507 type MediaCommandType = 'play' | 'pause' | 'next' | 'previous' | 'rewind' | 'seek' | 'setTrack';
1508}
1509export declare namespace interfaces.alexa.presentation.apl {
1510 /**
1511 * Whether the value is a relative or absolute offset. Defaults to absolute.
1512 * @enum
1513 */
1514 type Position = 'absolute' | 'relative';
1515}
1516export declare namespace interfaces.alexa.presentation.apl {
1517 /**
1518 * Provides context for any APL content shown on screen.
1519 * @interface
1520 */
1521 interface RenderedDocumentState {
1522 /**
1523 * The token specified in the RenderDocument directive which rendered the content shown on screen.
1524 */
1525 'token'?: string;
1526 /**
1527 * The APL version of the document which rendered the content shown on screen.
1528 */
1529 'version'?: string;
1530 /**
1531 * List of the visible APL components currently shown on screen.
1532 */
1533 'componentsVisibleOnScreen'?: Array<interfaces.alexa.presentation.apl.ComponentVisibleOnScreen>;
1534 /**
1535 * List of registered data sources' associated metadata
1536 */
1537 'dataSources'?: Array<any>;
1538 }
1539}
1540export declare namespace interfaces.alexa.presentation.apl {
1541 /**
1542 * Contains the runtime information for the interface.
1543 * @interface
1544 */
1545 interface Runtime {
1546 /**
1547 * Maximum APL version supported by the runtime.
1548 */
1549 'maxVersion'?: string;
1550 }
1551}
1552export declare namespace interfaces.alexa.presentation.apl {
1553 /**
1554 * A description of an error in APL functionality.
1555 * @interface
1556 */
1557 type RuntimeError = interfaces.alexa.presentation.apl.ListRuntimeError;
1558}
1559export declare namespace interfaces.alexa.presentation.apl {
1560 /**
1561 * Transform property to apply to a component.
1562 * @interface
1563 */
1564 type TransformProperty = interfaces.alexa.presentation.apl.MoveTransformProperty | interfaces.alexa.presentation.apl.ScaleTransformProperty | interfaces.alexa.presentation.apl.RotateTransformProperty | interfaces.alexa.presentation.apl.SkewTransformProperty;
1565}
1566export declare namespace interfaces.alexa.presentation.apl {
1567 /**
1568 * The source property holds the video clip or sequence of video clips to play.
1569 * @interface
1570 */
1571 interface VideoSource {
1572 /**
1573 * Optional description of this source material
1574 */
1575 'description'?: string;
1576 /**
1577 * Duration of time to play. If not set, defaults to the entire stream. Expressed in milliseconds.
1578 */
1579 'duration'?: number | string;
1580 /**
1581 * Media source material
1582 */
1583 'url': string;
1584 /**
1585 * Number of times to loop the video. Defaults to 0.
1586 */
1587 'repeatCount'?: number | string;
1588 /**
1589 * Offset to start playing at in the stream (defaults to 0).
1590 */
1591 'offset'?: number | string;
1592 }
1593}
1594export declare namespace interfaces.alexa.presentation.apl.listoperations {
1595 /**
1596 * An operation which adds, removes or replaces item(s) defined in a dynamicIndexList.
1597 * @interface
1598 */
1599 type Operation = interfaces.alexa.presentation.apl.listoperations.SetItemOperation | interfaces.alexa.presentation.apl.listoperations.InsertMultipleItemsOperation | interfaces.alexa.presentation.apl.listoperations.DeleteMultipleItemsOperation | interfaces.alexa.presentation.apl.listoperations.InsertItemOperation | interfaces.alexa.presentation.apl.listoperations.DeleteItemOperation;
1600}
1601export declare namespace interfaces.alexa.presentation.apla {
1602 /**
1603 * The reason for the failure.
1604 * @enum
1605 */
1606 type AudioSourceErrorReason = 'UNKNOWN_ERROR' | 'INTERNAL_SERVER_ERROR' | 'NOT_FOUND_ERROR' | 'SSL_HANDSHAKE_ERROR' | 'TIMEOUT_ERROR' | 'INVALID_URI_ERROR' | 'HTTPS_ERROR';
1607}
1608export declare namespace interfaces.alexa.presentation.apla {
1609 /**
1610 * The reason for the failure.
1611 * @enum
1612 */
1613 type DocumentErrorReason = 'UNKNOWN_ERROR' | 'INTERNAL_SERVER_ERROR';
1614}
1615export declare namespace interfaces.alexa.presentation.apla {
1616 /**
1617 * The reason for the failure.
1618 * @enum
1619 */
1620 type LinkErrorReason = 'UNKNOWN_ERROR' | 'INTERNAL_SERVER_ERROR' | 'NOT_FOUND_ERROR';
1621}
1622export declare namespace interfaces.alexa.presentation.apla {
1623 /**
1624 * The reason for the failure.
1625 * @enum
1626 */
1627 type RenderErrorReason = 'UNKNOWN_ERROR' | 'INTERNAL_SERVER_ERROR';
1628}
1629export declare namespace interfaces.alexa.presentation.apla {
1630 /**
1631 * A description of an error in APLA functionality.
1632 * @interface
1633 */
1634 type RuntimeError = interfaces.alexa.presentation.apla.AudioSourceRuntimeError | interfaces.alexa.presentation.apla.RenderRuntimeError | interfaces.alexa.presentation.apla.DocumentRuntimeError | interfaces.alexa.presentation.apla.LinkRuntimeError;
1635}
1636export declare namespace interfaces.alexa.presentation.aplt {
1637 /**
1638 *
1639 * @interface
1640 */
1641 interface AlexaPresentationApltInterface {
1642 'runtime'?: interfaces.alexa.presentation.aplt.Runtime;
1643 }
1644}
1645export declare namespace interfaces.alexa.presentation.aplt {
1646 /**
1647 * A message that can change the visual or audio presentation of the content on the screen.
1648 * @interface
1649 */
1650 type Command = interfaces.alexa.presentation.aplt.SetValueCommand | interfaces.alexa.presentation.aplt.IdleCommand | interfaces.alexa.presentation.aplt.AutoPageCommand | interfaces.alexa.presentation.aplt.ScrollCommand | interfaces.alexa.presentation.aplt.SendEventCommand | interfaces.alexa.presentation.aplt.ParallelCommand | interfaces.alexa.presentation.aplt.SetPageCommand | interfaces.alexa.presentation.aplt.SequentialCommand;
1651}
1652export declare namespace interfaces.alexa.presentation.aplt {
1653 /**
1654 * Whether the value is a relative or absolute offset. Defaults to absolute.
1655 * @enum
1656 */
1657 type Position = 'absolute' | 'relative';
1658}
1659export declare namespace interfaces.alexa.presentation.aplt {
1660 /**
1661 * Contains the runtime information for the interface.
1662 * @interface
1663 */
1664 interface Runtime {
1665 /**
1666 * Maximum APL-T version supported by the runtime.
1667 */
1668 'maxVersion'?: string;
1669 }
1670}
1671export declare namespace interfaces.alexa.presentation.aplt {
1672 /**
1673 * Name of a supported profile on character display.
1674 * @enum
1675 */
1676 type TargetProfile = 'FOUR_CHARACTER_CLOCK' | 'NONE';
1677}
1678export declare namespace interfaces.alexa.presentation.html {
1679 /**
1680 *
1681 * @interface
1682 */
1683 interface AlexaPresentationHtmlInterface {
1684 'runtime'?: interfaces.alexa.presentation.html.Runtime;
1685 }
1686}
1687export declare namespace interfaces.alexa.presentation.html {
1688 /**
1689 *
1690 * @interface
1691 */
1692 interface Configuration {
1693 /**
1694 * The number of seconds the content can stay on the screen without user interaction. Default value is 30 seconds. Maximum allowed value is 5 minutes.
1695 */
1696 'timeoutInSeconds'?: number;
1697 }
1698}
1699export declare namespace interfaces.alexa.presentation.html {
1700 /**
1701 * Contains the runtime information for the interface.
1702 * @interface
1703 */
1704 interface Runtime {
1705 /**
1706 * The max version of the HTML runtime supported by the device.
1707 */
1708 'maxVersion': string;
1709 }
1710}
1711export declare namespace interfaces.alexa.presentation.html {
1712 /**
1713 *
1714 * @interface
1715 */
1716 interface RuntimeError {
1717 'reason': interfaces.alexa.presentation.html.RuntimeErrorReason;
1718 /**
1719 * Details about why the error occurred
1720 */
1721 'message'?: string;
1722 /**
1723 * Error code
1724 */
1725 'code'?: string;
1726 }
1727}
1728export declare namespace interfaces.alexa.presentation.html {
1729 /**
1730 *
1731 * @enum
1732 */
1733 type RuntimeErrorReason = 'HTTP_REQUEST_ERROR' | 'TIMED_OUT' | 'FILE_TYPE_NOT_SUPPORTED' | 'APPLICATION_ERROR';
1734}
1735export declare namespace interfaces.alexa.presentation.html {
1736 /**
1737 *
1738 * @interface
1739 */
1740 interface StartRequest {
1741 'method': interfaces.alexa.presentation.html.StartRequestMethod;
1742 /**
1743 * HTTPS URI of the HTML page to load. This URI must abide by the [URI RFC 3986](https://tools.ietf.org/html/rfc3986). The HTML runtime must perform secure requests, using the HTTPS schema. Maximum size 8000 characters
1744 */
1745 'uri'?: string;
1746 /**
1747 * HTTP headers that the HTML runtime requires to access resources. Only the Authorization header and custom headers are allowed
1748 */
1749 'headers'?: any;
1750 }
1751}
1752export declare namespace interfaces.alexa.presentation.html {
1753 /**
1754 *
1755 * @enum
1756 */
1757 type StartRequestMethod = 'GET';
1758}
1759export declare namespace interfaces.alexa.presentation.html {
1760 /**
1761 * Properties for performing text to speech transformations. These are the same properties that [APL transformers](https://developer.amazon.com/docs/alexa-presentation-language/apl-data-source.html#transformer-properties-and-conversion-rules) use.
1762 * @interface
1763 */
1764 interface Transformer {
1765 'transformer': interfaces.alexa.presentation.html.TransformerType;
1766 /**
1767 * A JSON path that points to either a single entity in the message object, or a set of entities using wildcard or unresolved arrays. Examples 'family[*].name', 'address.street'. See [APL transformer properties](https://developer.amazon.com/docs/alexa-presentation-language/apl-data-source.html#transformer-properties-and-conversion-rules) for more details.
1768 */
1769 'inputPath': string;
1770 /**
1771 * Name of the output property to add to the message object. For example, if the inputPath is \"address.street\", the transformer output will be stored at \"address.outputName\". If no outputName is supplied, the transformer output will override the value at inputPath.
1772 */
1773 'outputName'?: string;
1774 }
1775}
1776export declare namespace interfaces.alexa.presentation.html {
1777 /**
1778 *
1779 * @enum
1780 */
1781 type TransformerType = 'ssmlToSpeech' | 'textToSpeech' | 'textToHint' | 'ssmlToText';
1782}
1783export declare namespace interfaces.amazonpay.model.request {
1784 /**
1785 *
1786 * @interface
1787 */
1788 type BaseAmazonPayEntity = interfaces.amazonpay.model.request.SellerBillingAgreementAttributes | interfaces.amazonpay.model.request.Price | interfaces.amazonpay.request.ChargeAmazonPayRequest | interfaces.amazonpay.model.request.BillingAgreementAttributes | interfaces.amazonpay.model.request.SellerOrderAttributes | interfaces.amazonpay.model.request.ProviderAttributes | interfaces.amazonpay.model.request.AuthorizeAttributes | interfaces.amazonpay.request.SetupAmazonPayRequest | interfaces.amazonpay.model.request.ProviderCredit;
1789}
1790export declare namespace interfaces.amazonpay.model.request {
1791 /**
1792 * * This is used to specify applicable billing agreement type. * CustomerInitiatedTransaction – customer is present at the time of processing payment for the order. * MerchantInitiatedTransaction – customer is not present at the time of processing payment for the order.
1793 * @enum
1794 */
1795 type BillingAgreementType = 'CustomerInitiatedTransaction' | 'MerchantInitiatedTransaction';
1796}
1797export declare namespace interfaces.amazonpay.model.request {
1798 /**
1799 * * This is used to specify applicable payment action. * Authorize – you want to confirm the order and authorize a certain amount, but you do not want to capture at this time. * AuthorizeAndCapture – you want to confirm the order, authorize for the given amount, and capture the funds.
1800 * @enum
1801 */
1802 type PaymentAction = 'Authorize' | 'AuthorizeAndCapture';
1803}
1804export declare namespace interfaces.amazonpay.model.response {
1805 /**
1806 * Indicates if the contract is for a Live (Production) or Sandbox environment.
1807 * @enum
1808 */
1809 type ReleaseEnvironment = 'LIVE' | 'SANDBOX';
1810}
1811export declare namespace interfaces.amazonpay.model.response {
1812 /**
1813 * Indicates the state that the Authorization object is in. For more information see “Authorization states and reason codes” under “States and reason codes” section in Amazon Pay API Reference Guide.
1814 * @enum
1815 */
1816 type State = 'Pending' | 'Open' | 'Declined' | 'Closed';
1817}
1818export declare namespace interfaces.amazonpay.model.v1 {
1819 /**
1820 * This object encapsulates details about an Authorization object including the status, amount captured and fee charged.
1821 * @interface
1822 */
1823 interface AuthorizationDetails {
1824 /**
1825 * This is AmazonPay generated identifier for this authorization transaction.
1826 */
1827 'amazonAuthorizationId'?: string;
1828 /**
1829 * This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
1830 */
1831 'authorizationReferenceId'?: string;
1832 /**
1833 * A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
1834 */
1835 'sellerAuthorizationNote'?: string;
1836 'authorizationAmount'?: interfaces.amazonpay.model.v1.Price;
1837 'capturedAmount'?: interfaces.amazonpay.model.v1.Price;
1838 'authorizationFee'?: interfaces.amazonpay.model.v1.Price;
1839 /**
1840 * list of AmazonCaptureId identifiers that have been requested on this Authorization object.
1841 */
1842 'idList'?: Array<string>;
1843 /**
1844 * This is the time at which the authorization was created.
1845 */
1846 'creationTimestamp'?: string;
1847 /**
1848 * This is the time at which the authorization expires.
1849 */
1850 'expirationTimestamp'?: string;
1851 'authorizationStatus'?: interfaces.amazonpay.model.v1.AuthorizationStatus;
1852 /**
1853 * This indicates whether an authorization resulted in a soft decline.
1854 */
1855 'softDecline'?: boolean;
1856 /**
1857 * This indicates whether a direct capture against the payment contract was specified.
1858 */
1859 'captureNow'?: boolean;
1860 /**
1861 * This is the description to be shown on the buyer's payment instrument statement if AuthorizeAndCapture was chosen.
1862 */
1863 'softDescriptor'?: string;
1864 }
1865}
1866export declare namespace interfaces.amazonpay.model.v1 {
1867 /**
1868 * Indicates the current status of an Authorization object, a Capture object, or a Refund object.
1869 * @interface
1870 */
1871 interface AuthorizationStatus {
1872 'state'?: interfaces.amazonpay.model.v1.State;
1873 /**
1874 * The reason that the Authorization object, Capture object, or Refund object is in the current state. For more information, see - https://pay.amazon.com/us/developer/documentation/apireference/201752950
1875 */
1876 'reasonCode'?: string;
1877 /**
1878 * Reason desciption corresponding to the reason code
1879 */
1880 'reasonDescription'?: string;
1881 /**
1882 * A timestamp that indicates the time when the authorization, capture, or refund state was last updated. In ISO 8601 format
1883 */
1884 'lastUpdateTimestamp'?: string;
1885 }
1886}
1887export declare namespace interfaces.amazonpay.model.v1 {
1888 /**
1889 * This is an object to set the attributes specified in the AuthorizeAttributes table. See the “AuthorizationDetails” section of the Amazon Pay API reference guide for details about this object.
1890 * @interface
1891 */
1892 interface AuthorizeAttributes {
1893 /**
1894 * This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
1895 */
1896 'authorizationReferenceId': string;
1897 'authorizationAmount': interfaces.amazonpay.model.v1.Price;
1898 /**
1899 * The maximum number of minutes allocated for the Authorize operation call to be processed. After this the authorization is automatically declined and you cannot capture funds against the authorization. The default value for Alexa transactions is 0. In order to speed up checkout time for voice users we recommend to not change this value.
1900 */
1901 'transactionTimeout'?: number;
1902 /**
1903 * A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
1904 */
1905 'sellerAuthorizationNote'?: string;
1906 /**
1907 * The description to be shown on the user's payment instrument statement if AuthorizeAndCapture is chosen. Format of soft descriptor sent to the payment processor is \"AMZ* <soft descriptor specified here>\". Default is \"AMZ*<SELLER_NAME> amzn.com/ pmts WA\". Maximum length can be 16 characters.
1908 */
1909 'softDescriptor'?: string;
1910 }
1911}
1912export declare namespace interfaces.amazonpay.model.v1 {
1913 /**
1914 * The merchant can choose to set the attributes specified in the BillingAgreementAttributes.
1915 * @interface
1916 */
1917 interface BillingAgreementAttributes {
1918 /**
1919 * Represents the SellerId of the Solution Provider that developed the eCommerce platform. This value is only used by Solution Providers, for whom it is required. It should not be provided by merchants creating their own custom integration. Do not specify the SellerId of the merchant for this request parameter. If you are a merchant, do not enter a PlatformId.
1920 */
1921 'platformId'?: string;
1922 /**
1923 * Represents a description of the billing agreement that is displayed in emails to the buyer.
1924 */
1925 'sellerNote'?: string;
1926 'sellerBillingAgreementAttributes'?: interfaces.amazonpay.model.v1.SellerBillingAgreementAttributes;
1927 'billingAgreementType'?: interfaces.amazonpay.model.v1.BillingAgreementType;
1928 'subscriptionAmount'?: interfaces.amazonpay.model.v1.Price;
1929 }
1930}
1931export declare namespace interfaces.amazonpay.model.v1 {
1932 /**
1933 * The result attributes from successful SetupAmazonPay call.
1934 * @interface
1935 */
1936 interface BillingAgreementDetails {
1937 /**
1938 * Billing agreement id which can be used for one time and recurring purchases
1939 */
1940 'billingAgreementId': string;
1941 /**
1942 * Time at which billing agreement details created.
1943 */
1944 'creationTimestamp'?: string;
1945 /**
1946 * The default shipping address of the buyer. Returned if needAmazonShippingAddress is set to true.
1947 */
1948 'destination'?: interfaces.amazonpay.model.v1.Destination;
1949 /**
1950 * Merchant's preferred language of checkout.
1951 */
1952 'checkoutLanguage'?: string;
1953 'releaseEnvironment': interfaces.amazonpay.model.v1.ReleaseEnvironment;
1954 'billingAgreementStatus': interfaces.amazonpay.model.v1.BillingAgreementStatus;
1955 }
1956}
1957export declare namespace interfaces.amazonpay.model.v1 {
1958 /**
1959 * Indicates the current status of the billing agreement. For more information about the State and ReasonCode response elements, see Billing agreement states and reason codes - https://pay.amazon.com/us/developer/documentation/apireference/201752870
1960 * @enum
1961 */
1962 type BillingAgreementStatus = 'CANCELED' | 'CLOSED' | 'DRAFT' | 'OPEN' | 'SUSPENDED';
1963}
1964export declare namespace interfaces.amazonpay.model.v1 {
1965 /**
1966 * * This is used to specify applicable billing agreement type. * CustomerInitiatedTransaction – customer is present at the time of processing payment for the order. * MerchantInitiatedTransaction – customer is not present at the time of processing payment for the order.
1967 * @enum
1968 */
1969 type BillingAgreementType = 'CustomerInitiatedTransaction' | 'MerchantInitiatedTransaction';
1970}
1971export declare namespace interfaces.amazonpay.model.v1 {
1972 /**
1973 * Destination object containing the details of an Address.
1974 * @interface
1975 */
1976 interface Destination {
1977 /**
1978 * The name or business name
1979 */
1980 'name'?: string;
1981 /**
1982 * The company name
1983 */
1984 'companyName'?: string;
1985 /**
1986 * The first line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
1987 */
1988 'addressLine1'?: string;
1989 /**
1990 * The second line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
1991 */
1992 'addressLine2'?: string;
1993 /**
1994 * The third line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
1995 */
1996 'addressLine3'?: string;
1997 /**
1998 * The city
1999 */
2000 'city'?: string;
2001 /**
2002 * The district or County
2003 */
2004 'districtOrCounty'?: string;
2005 /**
2006 * The state or region. This element is free text and can be either a 2-character code, fully spelled out, or abbreviated. Required. Note :- This response element is returned only in the U.S.
2007 */
2008 'stateOrRegion'?: string;
2009 /**
2010 * The postal code.
2011 */
2012 'postalCode'?: string;
2013 /**
2014 * The country code, in ISO 3166 format
2015 */
2016 'countryCode'?: string;
2017 /**
2018 * The phone number
2019 */
2020 'phone'?: string;
2021 }
2022}
2023export declare namespace interfaces.amazonpay.model.v1 {
2024 /**
2025 * * This is used to specify applicable payment action. * Authorize – you want to confirm the order and authorize a certain amount, but you do not want to capture at this time. * AuthorizeAndCapture – you want to confirm the order, authorize for the given amount, and capture the funds.
2026 * @enum
2027 */
2028 type PaymentAction = 'Authorize' | 'AuthorizeAndCapture';
2029}
2030export declare namespace interfaces.amazonpay.model.v1 {
2031 /**
2032 * This object specifies amount and currency authorized/captured.
2033 * @interface
2034 */
2035 interface Price {
2036 /**
2037 * Amount authorized/captured.
2038 */
2039 'amount': string;
2040 /**
2041 * Currency code for the amount.
2042 */
2043 'currencyCode': string;
2044 }
2045}
2046export declare namespace interfaces.amazonpay.model.v1 {
2047 /**
2048 * This is required only for Ecommerce provider (Solution provider) use cases.
2049 * @interface
2050 */
2051 interface ProviderAttributes {
2052 /**
2053 * Solution provider ID.
2054 */
2055 'providerId': string;
2056 /**
2057 * List of provider credit.
2058 */
2059 'providerCreditList': Array<interfaces.amazonpay.model.v1.ProviderCredit>;
2060 }
2061}
2062export declare namespace interfaces.amazonpay.model.v1 {
2063 /**
2064 *
2065 * @interface
2066 */
2067 interface ProviderCredit {
2068 /**
2069 * This is required only for Ecommerce provider (Solution provider) use cases.
2070 */
2071 'providerId'?: string;
2072 'credit'?: interfaces.amazonpay.model.v1.Price;
2073 }
2074}
2075export declare namespace interfaces.amazonpay.model.v1 {
2076 /**
2077 * Indicates if the order is for a Live (Production) or Sandbox environment.
2078 * @enum
2079 */
2080 type ReleaseEnvironment = 'LIVE' | 'SANDBOX';
2081}
2082export declare namespace interfaces.amazonpay.model.v1 {
2083 /**
2084 * Provides more context about the billing agreement that is represented by this Billing Agreement object.
2085 * @interface
2086 */
2087 interface SellerBillingAgreementAttributes {
2088 /**
2089 * The merchant-specified identifier of this billing agreement. At least one request parameter must be specified. Amazon recommends that you use only the following characters:- lowercase a-z, uppercase A-Z, numbers 0-9, dash (-), underscore (_).
2090 */
2091 'sellerBillingAgreementId'?: string;
2092 /**
2093 * The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings > Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
2094 */
2095 'storeName'?: string;
2096 /**
2097 * Any additional information that you wish to include with this billing agreement. At least one request parameter must be specified.
2098 */
2099 'customInformation'?: string;
2100 }
2101}
2102export declare namespace interfaces.amazonpay.model.v1 {
2103 /**
2104 * This object includes elements shown to buyers in emails and in their transaction history. See the “SellerOrderAttributes” section of the Amazon Pay API reference guide for details about this object.
2105 * @interface
2106 */
2107 interface SellerOrderAttributes {
2108 /**
2109 * The merchant-specified identifier of this order. This is shown to the buyer in their emails and transaction history on the Amazon Pay website.
2110 */
2111 'sellerOrderId'?: string;
2112 /**
2113 * The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings > Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
2114 */
2115 'storeName'?: string;
2116 /**
2117 * Any additional information that you want to include with this order reference.
2118 */
2119 'customInformation'?: string;
2120 /**
2121 * This represents a description of the order that is displayed in emails to the buyer.
2122 */
2123 'sellerNote'?: string;
2124 }
2125}
2126export declare namespace interfaces.amazonpay.model.v1 {
2127 /**
2128 * Indicates the state that the Authorization object, Capture object, or Refund object is in. For more information see - https://pay.amazon.com/us/developer/documentation/apireference/201752950
2129 * @enum
2130 */
2131 type State = 'Pending' | 'Open' | 'Declined' | 'Closed' | 'Completed';
2132}
2133export declare namespace interfaces.amazonpay.response {
2134 /**
2135 * Setup Amazon Pay Result Object. It is sent as part of the response to SetupAmazonPayRequest.
2136 * @interface
2137 */
2138 interface SetupAmazonPayResult {
2139 'billingAgreementDetails': interfaces.amazonpay.model.response.BillingAgreementDetails;
2140 }
2141}
2142export declare namespace interfaces.amazonpay.v1 {
2143 /**
2144 * Error response for SetupAmazonPay and ChargeAmazonPay calls.
2145 * @interface
2146 */
2147 interface AmazonPayErrorResponse {
2148 /**
2149 * Error code indicating the succinct cause of error
2150 */
2151 'errorCode': string;
2152 /**
2153 * Description of the error.
2154 */
2155 'errorMessage': string;
2156 }
2157}
2158export declare namespace interfaces.amazonpay.v1 {
2159 /**
2160 * Charge Amazon Pay Request Object
2161 * @interface
2162 */
2163 interface ChargeAmazonPay {
2164 /**
2165 * Authorization token that contains the permissions consented to by the user.
2166 */
2167 'consentToken'?: string;
2168 /**
2169 * The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
2170 */
2171 'sellerId': string;
2172 /**
2173 * The payment contract i.e. billing agreement created for the user.
2174 */
2175 'billingAgreementId': string;
2176 'paymentAction': interfaces.amazonpay.model.v1.PaymentAction;
2177 'authorizeAttributes': interfaces.amazonpay.model.v1.AuthorizeAttributes;
2178 'sellerOrderAttributes'?: interfaces.amazonpay.model.v1.SellerOrderAttributes;
2179 'providerAttributes'?: interfaces.amazonpay.model.v1.ProviderAttributes;
2180 }
2181}
2182export declare namespace interfaces.amazonpay.v1 {
2183 /**
2184 * Charge Amazon Pay Result Object. It is sent as part of the reponse to ChargeAmazonPay request.
2185 * @interface
2186 */
2187 interface ChargeAmazonPayResult {
2188 /**
2189 * The order reference identifier.
2190 */
2191 'amazonOrderReferenceId': string;
2192 'authorizationDetails': interfaces.amazonpay.model.v1.AuthorizationDetails;
2193 }
2194}
2195export declare namespace interfaces.amazonpay.v1 {
2196 /**
2197 * Setup Amazon Pay Request Object
2198 * @interface
2199 */
2200 interface SetupAmazonPay {
2201 /**
2202 * Authorization token that contains the permissions consented to by the user.
2203 */
2204 'consentToken'?: string;
2205 /**
2206 * The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
2207 */
2208 'sellerId': string;
2209 /**
2210 * The country in which the merchant has registered, as an Amazon Payments legal entity.
2211 */
2212 'countryOfEstablishment': string;
2213 /**
2214 * The currency of the merchant’s ledger account.
2215 */
2216 'ledgerCurrency': string;
2217 /**
2218 * The merchant's preferred language for checkout.
2219 */
2220 'checkoutLanguage'?: string;
2221 'billingAgreementAttributes'?: interfaces.amazonpay.model.v1.BillingAgreementAttributes;
2222 /**
2223 * To receive the default user shipping address in the response, set this parameter to true. Not required if a user shipping address is not required.
2224 */
2225 'needAmazonShippingAddress'?: boolean;
2226 /**
2227 * To test in Sandbox mode, set this parameter to true.
2228 */
2229 'sandboxMode'?: boolean;
2230 /**
2231 * Use this parameter to create a Sandbox payment object. In order to use this parameter, you first create a Sandbox user account in Seller Central. Then, pass the email address associated with that Sandbox user account.
2232 */
2233 'sandboxCustomerEmailId'?: string;
2234 }
2235}
2236export declare namespace interfaces.amazonpay.v1 {
2237 /**
2238 * Setup Amazon Pay Result Object. It is sent as part of the reponse to SetupAmazonPay request.
2239 * @interface
2240 */
2241 interface SetupAmazonPayResult {
2242 'billingAgreementDetails': interfaces.amazonpay.model.v1.BillingAgreementDetails;
2243 }
2244}
2245export declare namespace interfaces.applink {
2246 /**
2247 *
2248 * @interface
2249 */
2250 interface AppLinkInterface {
2251 'version'?: string;
2252 }
2253}
2254export declare namespace interfaces.applink {
2255 /**
2256 *
2257 * @interface
2258 */
2259 interface AppLinkState {
2260 'supportedCatalogTypes'?: Array<interfaces.applink.CatalogTypes>;
2261 'directLaunch'?: interfaces.applink.DirectLaunch;
2262 'sendToDevice'?: interfaces.applink.SendToDevice;
2263 }
2264}
2265export declare namespace interfaces.applink {
2266 /**
2267 * Accepted catalog types.
2268 * @enum
2269 */
2270 type CatalogTypes = 'IOS_APP_STORE' | 'GOOGLE_PLAY_STORE';
2271}
2272export declare namespace interfaces.applink {
2273 /**
2274 * direct launch availability
2275 * @interface
2276 */
2277 interface DirectLaunch {
2278 'IOS_APP_STORE'?: any;
2279 'GOOGLE_PLAY_STORE'?: any;
2280 }
2281}
2282export declare namespace interfaces.applink {
2283 /**
2284 * send to device availability
2285 * @interface
2286 */
2287 interface SendToDevice {
2288 }
2289}
2290export declare namespace interfaces.audioplayer {
2291 /**
2292 *
2293 * @interface
2294 */
2295 interface AudioItem {
2296 'stream'?: interfaces.audioplayer.Stream;
2297 'metadata'?: interfaces.audioplayer.AudioItemMetadata;
2298 }
2299}
2300export declare namespace interfaces.audioplayer {
2301 /**
2302 * Encapsulates the metadata about an AudioItem.
2303 * @interface
2304 */
2305 interface AudioItemMetadata {
2306 /**
2307 * An optional title of the audio item.
2308 */
2309 'title'?: string;
2310 /**
2311 * An optional subtitle of the audio item.
2312 */
2313 'subtitle'?: string;
2314 /**
2315 * An optional cover art image for the audio item.
2316 */
2317 'art'?: interfaces.display.Image;
2318 /**
2319 * An optional background image for the audio item.
2320 */
2321 'backgroundImage'?: interfaces.display.Image;
2322 }
2323}
2324export declare namespace interfaces.audioplayer {
2325 /**
2326 *
2327 * @interface
2328 */
2329 interface AudioPlayerInterface {
2330 }
2331}
2332export declare namespace interfaces.audioplayer {
2333 /**
2334 *
2335 * @interface
2336 */
2337 interface AudioPlayerState {
2338 'offsetInMilliseconds'?: number;
2339 'token'?: string;
2340 'playerActivity'?: interfaces.audioplayer.PlayerActivity;
2341 }
2342}
2343export declare namespace interfaces.audioplayer {
2344 /**
2345 *
2346 * @interface
2347 */
2348 interface CaptionData {
2349 /**
2350 * This contains the caption text.
2351 */
2352 'content'?: string;
2353 /**
2354 * Type of the caption source.
2355 */
2356 'type'?: interfaces.audioplayer.CaptionType;
2357 }
2358}
2359export declare namespace interfaces.audioplayer {
2360 /**
2361 *
2362 * @enum
2363 */
2364 type CaptionType = 'WEBVTT';
2365}
2366export declare namespace interfaces.audioplayer {
2367 /**
2368 *
2369 * @enum
2370 */
2371 type ClearBehavior = 'CLEAR_ALL' | 'CLEAR_ENQUEUED';
2372}
2373export declare namespace interfaces.audioplayer {
2374 /**
2375 *
2376 * @interface
2377 */
2378 interface CurrentPlaybackState {
2379 'offsetInMilliseconds'?: number;
2380 'playerActivity'?: interfaces.audioplayer.PlayerActivity;
2381 'token'?: string;
2382 }
2383}
2384export declare namespace interfaces.audioplayer {
2385 /**
2386 *
2387 * @interface
2388 */
2389 interface Error {
2390 'message'?: string;
2391 'type'?: interfaces.audioplayer.ErrorType;
2392 }
2393}
2394export declare namespace interfaces.audioplayer {
2395 /**
2396 *
2397 * @enum
2398 */
2399 type ErrorType = 'MEDIA_ERROR_INTERNAL_DEVICE_ERROR' | 'MEDIA_ERROR_INTERNAL_SERVER_ERROR' | 'MEDIA_ERROR_INVALID_REQUEST' | 'MEDIA_ERROR_SERVICE_UNAVAILABLE' | 'MEDIA_ERROR_UNKNOWN';
2400}
2401export declare namespace interfaces.audioplayer {
2402 /**
2403 *
2404 * @enum
2405 */
2406 type PlayBehavior = 'ENQUEUE' | 'REPLACE_ALL' | 'REPLACE_ENQUEUED';
2407}
2408export declare namespace interfaces.audioplayer {
2409 /**
2410 *
2411 * @enum
2412 */
2413 type PlayerActivity = 'PLAYING' | 'PAUSED' | 'FINISHED' | 'BUFFER_UNDERRUN' | 'IDLE' | 'STOPPED';
2414}
2415export declare namespace interfaces.audioplayer {
2416 /**
2417 *
2418 * @interface
2419 */
2420 interface Stream {
2421 'expectedPreviousToken'?: string;
2422 'token': string;
2423 'url': string;
2424 'offsetInMilliseconds': number;
2425 'captionData'?: interfaces.audioplayer.CaptionData;
2426 }
2427}
2428export declare namespace interfaces.automotive {
2429 /**
2430 * This object contains the automotive specific information of the device
2431 * @interface
2432 */
2433 interface AutomotiveState {
2434 }
2435}
2436export declare namespace interfaces.connections {
2437 /**
2438 * Connection Status indicates a high level understanding of the result of ConnectionsRequest.
2439 * @interface
2440 */
2441 interface ConnectionsStatus {
2442 /**
2443 * This is a code signifying the status of the request sent by the skill. Protocol adheres to HTTP status codes.
2444 */
2445 'code': string;
2446 /**
2447 * This is a message that goes along with response code that can provide more information about what occurred
2448 */
2449 'message'?: string;
2450 }
2451}
2452export declare namespace interfaces.connections {
2453 /**
2454 * This defines the callback mechanism when the task is completed, i.e., whether the requester wants to be resumed after the task is fulfilled or just be notified about errors without being resumed.
2455 * @enum
2456 */
2457 type OnCompletion = 'RESUME_SESSION' | 'SEND_ERRORS_ONLY';
2458}
2459export declare namespace interfaces.connections.entities {
2460 /**
2461 *
2462 * @interface
2463 */
2464 type BaseEntity = interfaces.connections.entities.PostalAddress | interfaces.connections.entities.Restaurant;
2465}
2466export declare namespace interfaces.connections.requests {
2467 /**
2468 *
2469 * @interface
2470 */
2471 type BaseRequest = interfaces.connections.requests.ScheduleFoodEstablishmentReservationRequest | interfaces.connections.requests.PrintImageRequest | interfaces.connections.requests.PrintWebPageRequest | interfaces.connections.requests.PrintPDFRequest | interfaces.connections.requests.ScheduleTaxiReservationRequest;
2472}
2473export declare namespace interfaces.conversations {
2474 /**
2475 * API request object
2476 * @interface
2477 */
2478 interface APIRequest {
2479 /**
2480 * API name
2481 */
2482 'name'?: string;
2483 /**
2484 * Object containing values for API arguments
2485 */
2486 'arguments'?: {
2487 [key: string]: any;
2488 };
2489 'slots'?: {
2490 [key: string]: SlotValue;
2491 };
2492 }
2493}
2494export declare namespace interfaces.customInterfaceController {
2495 /**
2496 * The endpoint of a gadget.
2497 * @interface
2498 */
2499 interface Endpoint {
2500 /**
2501 * The endpoint ID of the gadget.
2502 */
2503 'endpointId': string;
2504 }
2505}
2506export declare namespace interfaces.customInterfaceController {
2507 /**
2508 * An Event object defining a single event sent by an endpoint
2509 * @interface
2510 */
2511 interface Event {
2512 /**
2513 * The object that contains the header of the event.
2514 */
2515 'header': interfaces.customInterfaceController.Header;
2516 /**
2517 * The free form JSON object.
2518 */
2519 'payload': any;
2520 /**
2521 * Identifies where the event orginated from.
2522 */
2523 'endpoint'?: interfaces.customInterfaceController.Endpoint;
2524 }
2525}
2526export declare namespace interfaces.customInterfaceController {
2527 /**
2528 * Defines the Jsonlogic event filter expression and its corresponding match action. This filter is applied to all events during the event handler's duration. Events that are rejected by the filter expression are not sent to the skill.
2529 * @interface
2530 */
2531 interface EventFilter {
2532 /**
2533 * The JSON object that represents the Jsonlogic expression against which the events are evaluated. If this expression is satisfied, the corresponding match action is performed.
2534 */
2535 'filterExpression': any;
2536 'filterMatchAction': interfaces.customInterfaceController.FilterMatchAction;
2537 }
2538}
2539export declare namespace interfaces.customInterfaceController {
2540 /**
2541 * This object defines the duration of the Event Handler and the optional JSON payload that is delivered to the skill when the timer expires.
2542 * @interface
2543 */
2544 interface Expiration {
2545 /**
2546 * The length of time, in milliseconds, for which events from connected gadgets will be passed to the skill. Your skill will continue to receive events until this duration expires or the event handler is otherwise stopped.
2547 */
2548 'durationInMilliseconds': number;
2549 /**
2550 * The payload that was defined in the StartEventHandlerDirective. The skill will receive if and only if the Event Handler duration expired.
2551 */
2552 'expirationPayload'?: any;
2553 }
2554}
2555export declare namespace interfaces.customInterfaceController {
2556 /**
2557 * The behavior to be performed by the platform on a successful filter expression match.
2558 * @enum
2559 */
2560 type FilterMatchAction = 'SEND_AND_TERMINATE' | 'SEND';
2561}
2562export declare namespace interfaces.customInterfaceController {
2563 /**
2564 * Endpoint Event header
2565 * @interface
2566 */
2567 interface Header {
2568 /**
2569 * The developer-defined namespace for the custom interface.
2570 */
2571 'namespace': string;
2572 /**
2573 * The developer-defined name of the custom interface.
2574 */
2575 'name': string;
2576 }
2577}
2578export declare namespace interfaces.display {
2579 /**
2580 *
2581 * @enum
2582 */
2583 type BackButtonBehavior = 'HIDDEN' | 'VISIBLE';
2584}
2585export declare namespace interfaces.display {
2586 /**
2587 *
2588 * @interface
2589 */
2590 interface DisplayInterface {
2591 'templateVersion'?: string;
2592 'markupVersion'?: string;
2593 }
2594}
2595export declare namespace interfaces.display {
2596 /**
2597 *
2598 * @interface
2599 */
2600 interface DisplayState {
2601 'token'?: string;
2602 }
2603}
2604export declare namespace interfaces.display {
2605 /**
2606 *
2607 * @interface
2608 */
2609 type Hint = interfaces.display.PlainTextHint;
2610}
2611export declare namespace interfaces.display {
2612 /**
2613 *
2614 * @interface
2615 */
2616 interface Image {
2617 'contentDescription'?: string;
2618 'sources'?: Array<interfaces.display.ImageInstance>;
2619 }
2620}
2621export declare namespace interfaces.display {
2622 /**
2623 *
2624 * @interface
2625 */
2626 interface ImageInstance {
2627 'url': string;
2628 'size'?: interfaces.display.ImageSize;
2629 'widthPixels'?: number;
2630 'heightPixels'?: number;
2631 }
2632}
2633export declare namespace interfaces.display {
2634 /**
2635 *
2636 * @enum
2637 */
2638 type ImageSize = 'X_SMALL' | 'SMALL' | 'MEDIUM' | 'LARGE' | 'X_LARGE';
2639}
2640export declare namespace interfaces.display {
2641 /**
2642 *
2643 * @interface
2644 */
2645 interface ListItem {
2646 'token': string;
2647 'image'?: interfaces.display.Image;
2648 'textContent'?: interfaces.display.TextContent;
2649 }
2650}
2651export declare namespace interfaces.display {
2652 /**
2653 *
2654 * @interface
2655 */
2656 type Template = interfaces.display.ListTemplate2 | interfaces.display.ListTemplate1 | interfaces.display.BodyTemplate7 | interfaces.display.BodyTemplate6 | interfaces.display.BodyTemplate3 | interfaces.display.BodyTemplate2 | interfaces.display.BodyTemplate1;
2657}
2658export declare namespace interfaces.display {
2659 /**
2660 *
2661 * @interface
2662 */
2663 interface TextContent {
2664 'primaryText'?: interfaces.display.TextField;
2665 'secondaryText'?: interfaces.display.TextField;
2666 'tertiaryText'?: interfaces.display.TextField;
2667 }
2668}
2669export declare namespace interfaces.display {
2670 /**
2671 *
2672 * @interface
2673 */
2674 type TextField = interfaces.display.RichText | interfaces.display.PlainText;
2675}
2676export declare namespace interfaces.geolocation {
2677 /**
2678 * A string representing if Alexa has access to location services running on the hostOS of device.
2679 * @enum
2680 */
2681 type Access = 'ENABLED' | 'DISABLED' | 'UNKNOWN';
2682}
2683export declare namespace interfaces.geolocation {
2684 /**
2685 * An object containing the altitude information of the device.
2686 * @interface
2687 */
2688 interface Altitude {
2689 /**
2690 * A double representing the altitude of the device in meters.
2691 */
2692 'altitudeInMeters': number;
2693 /**
2694 * A double representing the accuracy of the altitude measurement in meters.
2695 */
2696 'accuracyInMeters': number;
2697 }
2698}
2699export declare namespace interfaces.geolocation {
2700 /**
2701 * An object containing the location information of the device.
2702 * @interface
2703 */
2704 interface Coordinate {
2705 /**
2706 * A double representing the latitude in degrees of the device.
2707 */
2708 'latitudeInDegrees': number;
2709 /**
2710 * A double representing the longitude in degrees of the device.
2711 */
2712 'longitudeInDegrees': number;
2713 /**
2714 * A double representing the accuracy of geolocation data in meters.
2715 */
2716 'accuracyInMeters': number;
2717 }
2718}
2719export declare namespace interfaces.geolocation {
2720 /**
2721 * The common object to define the basic geolocation states
2722 * @interface
2723 */
2724 interface GeolocationCommonState {
2725 /**
2726 * Specifies the time when the geolocation data was last collected on the device.
2727 */
2728 'timestamp'?: string;
2729 'coordinate'?: interfaces.geolocation.Coordinate;
2730 'altitude'?: interfaces.geolocation.Altitude;
2731 'heading'?: interfaces.geolocation.Heading;
2732 'speed'?: interfaces.geolocation.Speed;
2733 }
2734}
2735export declare namespace interfaces.geolocation {
2736 /**
2737 *
2738 * @interface
2739 */
2740 interface GeolocationInterface {
2741 }
2742}
2743export declare namespace interfaces.geolocation {
2744 /**
2745 * An object containing the heading direction information of the device.
2746 * @interface
2747 */
2748 interface Heading {
2749 /**
2750 * A double representing the direction of the device in degrees.
2751 */
2752 'directionInDegrees': number;
2753 /**
2754 * A double representing the accuracy of the heading measurement in degrees.
2755 */
2756 'accuracyInDegrees'?: number;
2757 }
2758}
2759export declare namespace interfaces.geolocation {
2760 /**
2761 * An object containing status and access.
2762 * @interface
2763 */
2764 interface LocationServices {
2765 /**
2766 * A string representing the status of whether location services is currently running or not on the host OS of device.
2767 */
2768 'status': interfaces.geolocation.Status;
2769 /**
2770 * A string representing if Alexa has access to location services running on the hostOS of device.
2771 */
2772 'access': interfaces.geolocation.Access;
2773 }
2774}
2775export declare namespace interfaces.geolocation {
2776 /**
2777 * An object containing the speed information of the device.
2778 * @interface
2779 */
2780 interface Speed {
2781 /**
2782 * A double representing the speed of the device in meters.
2783 */
2784 'speedInMetersPerSecond': number;
2785 /**
2786 * A double representing the accuracy of the speed measurement in meters.
2787 */
2788 'accuracyInMetersPerSecond'?: number;
2789 }
2790}
2791export declare namespace interfaces.geolocation {
2792 /**
2793 * A string representing the status of whether location services is currently running or not on the host OS of device.
2794 * @enum
2795 */
2796 type Status = 'RUNNING' | 'STOPPED';
2797}
2798export declare namespace interfaces.monetization.v1 {
2799 /**
2800 * Entity to define In Skill Product over which actions will be performed.
2801 * @interface
2802 */
2803 interface InSkillProduct {
2804 /**
2805 * The product ID of In Skill Product.
2806 */
2807 'productId': string;
2808 }
2809}
2810export declare namespace interfaces.monetization.v1 {
2811 /**
2812 * Response from purchase directives: * ACCEPTED - User have accepted the offer to purchase the product * DECLINED - User have declined the offer to purchase the product * NOT_ENTITLED - User tries to cancel/return a product he/she is not entitled to. * ALREADY_PURCHASED - User has already purchased the product * ERROR - An internal error occurred
2813 * @enum
2814 */
2815 type PurchaseResult = 'ACCEPTED' | 'DECLINED' | 'NOT_ENTITLED' | 'ERROR' | 'ALREADY_PURCHASED';
2816}
2817export declare namespace interfaces.navigation {
2818 /**
2819 *
2820 * @interface
2821 */
2822 interface NavigationInterface {
2823 }
2824}
2825export declare namespace interfaces.system {
2826 /**
2827 *
2828 * @interface
2829 */
2830 interface Error {
2831 'type': interfaces.system.ErrorType;
2832 'message'?: string;
2833 }
2834}
2835export declare namespace interfaces.system {
2836 /**
2837 *
2838 * @interface
2839 */
2840 interface ErrorCause {
2841 'requestId': string;
2842 }
2843}
2844export declare namespace interfaces.system {
2845 /**
2846 *
2847 * @enum
2848 */
2849 type ErrorType = 'INVALID_RESPONSE' | 'DEVICE_COMMUNICATION_ERROR' | 'INTERNAL_SERVICE_ERROR';
2850}
2851export declare namespace interfaces.system {
2852 /**
2853 *
2854 * @interface
2855 */
2856 interface SystemState {
2857 'application': Application;
2858 'user': User;
2859 'device'?: Device;
2860 'person'?: Person;
2861 'unit'?: interfaces.systemUnit.Unit;
2862 /**
2863 * A string that references the correct base URI to refer to by region, for use with APIs such as the Device Location API and Progressive Response API.
2864 */
2865 'apiEndpoint': string;
2866 /**
2867 * A bearer token string that can be used by the skill (during the skill session) to access Alexa APIs resources of the registered Alexa customer and/or person who is making the request. This token encapsulates the permissions authorized under the registered Alexa account and device, and (optionally) the recognized person. Some resources, such as name or email, require explicit customer consent.\"
2868 */
2869 'apiAccessToken'?: string;
2870 }
2871}
2872export declare namespace interfaces.systemUnit {
2873 /**
2874 * An object that represents a logical entity for organizing actors and resources that interact with Alexa systems.
2875 * @interface
2876 */
2877 interface Unit {
2878 /**
2879 * A string that represents a unique identifier for the unit in the context of a request. The length of this identifier can vary, but is never more than 255 characters. Alexa generates this string only when a request made to your skill has a valid unit context. This identifier is scoped to a skill. Normally, disabling and re-enabling a skill generates a new identifier.
2880 */
2881 'unitId'?: string;
2882 /**
2883 * A string that represents a unique identifier for the unit in the context of a request. The length of this identifier can vary, but is never more than 255 characters. Alexa generates this string only when the request made to your skill has a valid unit context. This is another unit identifier associated with an organization's developer account. Only registered Alexa for Residential and Alexa for Hospitality vendors can see the Read PersistentUnitId toggle in the Alexa skills developers console. This identifier is scoped to a vendor, therefore all skills that belong to particular vendor share this identifier, therefore it will stay the same regardless of skill enablement.
2884 */
2885 'persistentUnitId'?: string;
2886 }
2887}
2888export declare namespace interfaces.videoapp {
2889 /**
2890 *
2891 * @interface
2892 */
2893 interface Metadata {
2894 'title'?: string;
2895 'subtitle'?: string;
2896 }
2897}
2898export declare namespace interfaces.videoapp {
2899 /**
2900 *
2901 * @interface
2902 */
2903 interface VideoAppInterface {
2904 }
2905}
2906export declare namespace interfaces.videoapp {
2907 /**
2908 *
2909 * @interface
2910 */
2911 interface VideoItem {
2912 'source': string;
2913 'metadata'?: interfaces.videoapp.Metadata;
2914 }
2915}
2916export declare namespace interfaces.viewport {
2917 /**
2918 * Indicates that dialog playback is supported or desired in the given interaction mode. Player interface abilities controlled by this field are any directives that would render audio on the dialog channel.
2919 * @enum
2920 */
2921 type Dialog = 'SUPPORTED' | 'UNSUPPORTED';
2922}
2923export declare namespace interfaces.viewport {
2924 /**
2925 * An experience represents a viewing mode used to interact with the device.
2926 * @interface
2927 */
2928 interface Experience {
2929 /**
2930 * The number of horizontal arc minutes the viewport occupies in the user's visual field when viewed within this experience.
2931 */
2932 'arcMinuteWidth'?: number;
2933 /**
2934 * The number of vertical arc minutes the viewport occupies in the user's visual field when viewed within this experience.
2935 */
2936 'arcMinuteHeight'?: number;
2937 /**
2938 * Indicates if the viewport can be rotated through 90 degrees.
2939 */
2940 'canRotate'?: boolean;
2941 /**
2942 * Indicates if the viewport can be resized, limiting the area which can be used to render the APL response.
2943 */
2944 'canResize'?: boolean;
2945 }
2946}
2947export declare namespace interfaces.viewport {
2948 /**
2949 * Represents a physical button input mechanism which can be used to interact with elements shown on the viewport.
2950 * @enum
2951 */
2952 type Keyboard = 'DIRECTION';
2953}
2954export declare namespace interfaces.viewport {
2955 /**
2956 * The expected use case of the device's viewport, encapsulating the available input mechanisms and user viewing distance.
2957 * @enum
2958 */
2959 type Mode = 'AUTO' | 'HUB' | 'MOBILE' | 'PC' | 'TV';
2960}
2961export declare namespace interfaces.viewport {
2962 /**
2963 * Type of the viewport. * `STANDARD` Indicates that this viewport occupies an exclusive area of the screen. * `OVERLAY` Indicates that the viewport is an overlay, sharing the screen with other experiences.
2964 * @enum
2965 */
2966 type PresentationType = 'STANDARD' | 'OVERLAY';
2967}
2968export declare namespace interfaces.viewport {
2969 /**
2970 * The shape of the viewport.
2971 * @enum
2972 */
2973 type Shape = 'RECTANGLE' | 'ROUND';
2974}
2975export declare namespace interfaces.viewport {
2976 /**
2977 * Represents a type of touch input suppported by the device.
2978 * @enum
2979 */
2980 type Touch = 'SINGLE';
2981}
2982export declare namespace interfaces.viewport {
2983 /**
2984 *
2985 * @interface
2986 */
2987 type TypedViewportState = interfaces.viewport.APLViewportState | interfaces.viewport.APLTViewportState;
2988}
2989export declare namespace interfaces.viewport {
2990 /**
2991 * This object contains the characteristics related to the device's viewport.
2992 * @interface
2993 */
2994 interface ViewportState {
2995 /**
2996 * The experiences supported by the device, in descending order of arcMinuteWidth and arcMinuteHeight.
2997 */
2998 'experiences'?: Array<interfaces.viewport.Experience>;
2999 'mode'?: interfaces.viewport.Mode;
3000 'shape'?: interfaces.viewport.Shape;
3001 /**
3002 * The number of pixels present in the viewport at its maximum width.
3003 */
3004 'pixelWidth'?: number;
3005 /**
3006 * The number of pixels present in the viewport at its maximum height.
3007 */
3008 'pixelHeight'?: number;
3009 /**
3010 * The pixel density of the viewport.
3011 */
3012 'dpi'?: number;
3013 /**
3014 * The number of horizontal pixels in the viewport that are currently available for Alexa to render an experience.
3015 */
3016 'currentPixelWidth'?: number;
3017 /**
3018 * The number of vertical pixels in the viewport that are currently available for Alexa to render an experience.
3019 */
3020 'currentPixelHeight'?: number;
3021 /**
3022 * The types of touch supported by the device. An empty array indicates no touch support.
3023 */
3024 'touch'?: Array<interfaces.viewport.Touch>;
3025 /**
3026 * The physical button input mechanisms supported by the device. An empty array indicates physical button input is unsupported.
3027 */
3028 'keyboard'?: Array<interfaces.viewport.Keyboard>;
3029 'video'?: interfaces.viewport.ViewportStateVideo;
3030 }
3031}
3032export declare namespace interfaces.viewport {
3033 /**
3034 * Details of the technologies which are available for playing video on the device.
3035 * @interface
3036 */
3037 interface ViewportStateVideo {
3038 /**
3039 * Codecs which are available for playing video on the device.
3040 */
3041 'codecs'?: Array<interfaces.viewport.video.Codecs>;
3042 }
3043}
3044export declare namespace interfaces.viewport {
3045 /**
3046 * Details of the technologies which are available for playing video on the device.
3047 * @interface
3048 */
3049 interface ViewportVideo {
3050 /**
3051 * Codecs which are available for playing video on the device.
3052 */
3053 'codecs'?: Array<interfaces.viewport.video.Codecs>;
3054 }
3055}
3056export declare namespace interfaces.viewport.apl {
3057 /**
3058 * The viewport configuration at the time of the request.
3059 * @interface
3060 */
3061 interface CurrentConfiguration {
3062 'mode': interfaces.viewport.Mode;
3063 'video'?: interfaces.viewport.ViewportVideo;
3064 'size': interfaces.viewport.size.ViewportSize;
3065 'dialog'?: interfaces.viewport.Dialog;
3066 }
3067}
3068export declare namespace interfaces.viewport.apl {
3069 /**
3070 *
3071 * @interface
3072 */
3073 interface ViewportConfiguration {
3074 'current': interfaces.viewport.apl.CurrentConfiguration;
3075 }
3076}
3077export declare namespace interfaces.viewport.aplt {
3078 /**
3079 * Supported character set on a text display * `SEVEN_SEGMENT` - 7-segment display
3080 * @enum
3081 */
3082 type CharacterFormat = 'SEVEN_SEGMENT';
3083}
3084export declare namespace interfaces.viewport.aplt {
3085 /**
3086 *
3087 * @interface
3088 */
3089 interface InterSegment {
3090 /**
3091 * horizontal position (0-based index) in characters
3092 */
3093 'x': number;
3094 /**
3095 * vertical position (0-based index) in rows
3096 */
3097 'y': number;
3098 /**
3099 * list of characters that can be rendered
3100 */
3101 'characters': string;
3102 }
3103}
3104export declare namespace interfaces.viewport.aplt {
3105 /**
3106 * name of viewport's profile
3107 * @enum
3108 */
3109 type ViewportProfile = 'FOUR_CHARACTER_CLOCK';
3110}
3111export declare namespace interfaces.viewport.size {
3112 /**
3113 * Information regarding the range of sizes for a configuration.
3114 * @interface
3115 */
3116 type ViewportSize = interfaces.viewport.size.ContinuousViewportSize | interfaces.viewport.size.DiscreteViewportSize;
3117}
3118export declare namespace interfaces.viewport.video {
3119 /**
3120 * A named bundle of codecs which are available for playing video on the viewport.
3121 * @enum
3122 */
3123 type Codecs = 'H_264_41' | 'H_264_42';
3124}
3125export declare namespace services.datastore.v1 {
3126 /**
3127 *
3128 * @interface
3129 */
3130 interface CancelCommandsRequestError {
3131 'type': services.datastore.v1.CancelCommandsRequestErrorType;
3132 /**
3133 * Descriptive error message.
3134 */
3135 'message'?: string;
3136 }
3137}
3138export declare namespace services.datastore.v1 {
3139 /**
3140 * Error code of the response. * `COMMANDS_DELIVERED` - The pending commands have been delivered. * `CONCURRENCY_ERROR` - There are concurrent attempts to deliver the pending commands. * `NOT_FOUND` - Unable to find pending request for the given queuedResultId. * `INVALID_ACCESS_TOKEN` - Access token is expire or invalid. * `DATASTORE_SUPPORT_REQUIRED` - Client has not opted into DataStore interface in skill manifest. * `TOO_MANY_REQUESTS` - The request has been throttled because client has exceed maximum allowed request rate. * `DATASTORE_UNAVAILABLE` - Internal service error.
3141 * @enum
3142 */
3143 type CancelCommandsRequestErrorType = 'COMMANDS_DELIVERED' | 'CONCURRENCY_ERROR' | 'NOT_FOUND' | 'INVALID_ACCESS_TOKEN' | 'DATASTORE_SUPPORT_REQUIRED' | 'TOO_MANY_REQUESTS' | 'DATASTORE_UNAVAILABLE';
3144}
3145export declare namespace services.datastore.v1 {
3146 /**
3147 * DataStore command which will run in DataStore.
3148 * @interface
3149 */
3150 type Command = services.datastore.v1.RemoveNamespaceCommand | services.datastore.v1.RemoveObjectCommand | services.datastore.v1.PutObjectCommand | services.datastore.v1.ClearCommand | services.datastore.v1.PutNamespaceCommand;
3151}
3152export declare namespace services.datastore.v1 {
3153 /**
3154 *
3155 * @interface
3156 */
3157 interface CommandsDispatchResult {
3158 /**
3159 * identifier of a device.
3160 */
3161 'deviceId': string;
3162 'type': services.datastore.v1.DispatchResultType;
3163 /**
3164 * Opaque description of the error.
3165 */
3166 'message'?: string;
3167 }
3168}
3169export declare namespace services.datastore.v1 {
3170 /**
3171 *
3172 * @interface
3173 */
3174 interface CommandsRequest {
3175 /**
3176 * Collection of ordered commands which needs to be executed in DataStore.
3177 */
3178 'commands': Array<services.datastore.v1.Command>;
3179 /**
3180 * Target where update needs to be published.
3181 */
3182 'target': services.datastore.v1.Target;
3183 /**
3184 * Date and time, in ISO-8601 representation, when to halt the attempt to deliver the commands.
3185 */
3186 'attemptDeliveryUntil'?: string;
3187 }
3188}
3189export declare namespace services.datastore.v1 {
3190 /**
3191 *
3192 * @interface
3193 */
3194 interface CommandsRequestError {
3195 'type': services.datastore.v1.CommandsRequestErrorType;
3196 /**
3197 * Descriptive error message.
3198 */
3199 'message'?: string;
3200 }
3201}
3202export declare namespace services.datastore.v1 {
3203 /**
3204 * Error code of the response. * `COMMANDS_PAYLOAD_EXCEEDS_LIMIT` - The total size of commands cannot exceed maximum size in UTF-encoding. * `TOO_MANY_TARGETS` - Number of target exceeds limits. * `NO_TARGET_DEFINED` - There is no target defined. * `INVALID_REQUEST` - request payload does not compliant with JSON schema. * `INVALID_ACCESS_TOKEN` - Access token is expire or invalid. * `DATASTORE_SUPPORT_REQUIRED` - Client has not opted into DataStore interface in skill manifest. * `TOO_MANY_REQUESTS` - The request has been throttled because client has exceed maximum allowed request rate. * `DATASTORE_UNAVAILABLE` - Internal service error.
3205 * @enum
3206 */
3207 type CommandsRequestErrorType = 'COMMANDS_PAYLOAD_EXCEEDS_LIMIT' | 'TOO_MANY_TARGETS' | 'NO_TARGET_DEFINED' | 'INVALID_REQUEST' | 'INVALID_ACCESS_TOKEN' | 'DATASTORE_SUPPORT_REQUIRED' | 'TOO_MANY_REQUESTS' | 'DATASTORE_UNAVAILABLE';
3208}
3209export declare namespace services.datastore.v1 {
3210 /**
3211 *
3212 * @interface
3213 */
3214 interface CommandsResponse {
3215 /**
3216 * List of results for each dispatch to a device target. This indicates the results of 1st attempt of deliveries.
3217 */
3218 'results': Array<services.datastore.v1.CommandsDispatchResult>;
3219 /**
3220 * A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE). If there is no offline device, this value is not specified. The result will be available for query at least one hour after attemptDeliveryUntil.
3221 */
3222 'queuedResultId'?: string;
3223 }
3224}
3225export declare namespace services.datastore.v1 {
3226 /**
3227 * Defines success or a type of error from dispatch. * `SUCCESS` - device has received the payload. * `INVALID_DEVICE` - device is not capable of processing the payload. * `DEVICE_UNAVAILABLE` - dispatch failed because device is offline. * `DEVICE_PERMANENTLY_UNAVAILABLE` - target no longer available to receive data. This is reported for a failed delivery attempt related to an unregistered device. * `CONCURRENCY_ERROR` - there are concurrent attempts to update to the same device. * `INTERNAL_ERROR`- dispatch failed because of unknown error - see message. * `PENDING_REQUEST_COUNT_EXCEEDS_LIMIT` - the count of pending requests exceeds the limit.
3228 * @enum
3229 */
3230 type DispatchResultType = 'SUCCESS' | 'INVALID_DEVICE' | 'DEVICE_UNAVAILABLE' | 'DEVICE_PERMANENTLY_UNAVAILABLE' | 'CONCURRENCY_ERROR' | 'INTERNAL_ERROR' | 'PENDING_REQUEST_COUNT_EXCEEDS_LIMIT';
3231}
3232export declare namespace services.datastore.v1 {
3233 /**
3234 *
3235 * @interface
3236 */
3237 interface QueuedResultRequestError {
3238 'type': services.datastore.v1.QueuedResultRequestErrorType;
3239 /**
3240 * Descriptive error message.
3241 */
3242 'message'?: string;
3243 }
3244}
3245export declare namespace services.datastore.v1 {
3246 /**
3247 * Error code of the response. * `NOT_FOUND` - queuedResultId is not found for the skill. * `INVALID_REQUEST` - One or more request parameters are invalid, see message for more details. * `INVALID_ACCESS_TOKEN` - Access token is expire or invalid. * `DATASTORE_SUPPORT_REQUIRED` - Client has not opted into DataStore interface in skill manifest. * `TOO_MANY_REQUESTS` - The request has been throttled because client has exceed maximum allowed request rate. * `DATASTORE_UNAVAILABLE` - Internal service error.
3248 * @enum
3249 */
3250 type QueuedResultRequestErrorType = 'NOT_FOUND' | 'INVALID_REQUEST' | 'INVALID_ACCESS_TOKEN' | 'DATASTORE_SUPPORT_REQUIRED' | 'TOO_MANY_REQUESTS' | 'DATASTORE_UNAVAILABLE';
3251}
3252export declare namespace services.datastore.v1 {
3253 /**
3254 * Response for queued deliveries query.
3255 * @interface
3256 */
3257 interface QueuedResultResponse {
3258 /**
3259 * The array only contains results which have not been a SUCCESS delivery. An empty response means that all targeted devices has been received the commands payload.
3260 */
3261 'items': Array<services.datastore.v1.CommandsDispatchResult>;
3262 'paginationContext'?: services.datastore.v1.ResponsePaginationContext;
3263 }
3264}
3265export declare namespace services.datastore.v1 {
3266 /**
3267 *
3268 * @interface
3269 */
3270 interface ResponsePaginationContext {
3271 /**
3272 * The total number of results at the time of current response.
3273 */
3274 'totalCount': number;
3275 /**
3276 * The token of previous page - Not specified for the response of first page.
3277 */
3278 'previousToken'?: string;
3279 /**
3280 * The token of next page - Not specified for the response of last page.
3281 */
3282 'nextToken'?: string;
3283 }
3284}
3285export declare namespace services.datastore.v1 {
3286 /**
3287 *
3288 * @interface
3289 */
3290 type Target = services.datastore.v1.User | services.datastore.v1.Devices;
3291}
3292export declare namespace services.deviceAddress {
3293 /**
3294 * Represents the full address response from the service.
3295 * @interface
3296 */
3297 interface Address {
3298 'addressLine1'?: string;
3299 'addressLine2'?: string;
3300 'addressLine3'?: string;
3301 'countryCode'?: string;
3302 'stateOrRegion'?: string;
3303 'city'?: string;
3304 'districtOrCounty'?: string;
3305 'postalCode'?: string;
3306 }
3307}
3308export declare namespace services.deviceAddress {
3309 /**
3310 *
3311 * @interface
3312 */
3313 interface Error {
3314 /**
3315 * The corresponding type of the http status code being returned.
3316 */
3317 'type'?: string;
3318 /**
3319 * A human readable description of error.
3320 */
3321 'message'?: string;
3322 }
3323}
3324export declare namespace services.deviceAddress {
3325 /**
3326 *
3327 * @interface
3328 */
3329 interface ShortAddress {
3330 'countryCode'?: string;
3331 'postalCode'?: string;
3332 }
3333}
3334export declare namespace services.directive {
3335 /**
3336 *
3337 * @interface
3338 */
3339 type Directive = services.directive.SpeakDirective;
3340}
3341export declare namespace services.directive {
3342 /**
3343 *
3344 * @interface
3345 */
3346 interface Error {
3347 /**
3348 * error code to find more information in developer.amazon.com.
3349 */
3350 'code': number;
3351 /**
3352 * Readable description of error.
3353 */
3354 'message': string;
3355 }
3356}
3357export declare namespace services.directive {
3358 /**
3359 *
3360 * @interface
3361 */
3362 interface Header {
3363 /**
3364 * This represents the current requestId for what the skill/speechlet was invoked.
3365 */
3366 'requestId': string;
3367 }
3368}
3369export declare namespace services.directive {
3370 /**
3371 * Send Directive Request payload.
3372 * @interface
3373 */
3374 interface SendDirectiveRequest {
3375 /**
3376 * contains the header attributes of the send directive request.
3377 */
3378 'header': services.directive.Header;
3379 /**
3380 * Directive Content.
3381 */
3382 'directive': services.directive.Directive;
3383 }
3384}
3385export declare namespace services.endpointEnumeration {
3386 /**
3387 *
3388 * @interface
3389 */
3390 interface EndpointCapability {
3391 /**
3392 * The name of the capability interface.
3393 */
3394 'interface'?: string;
3395 /**
3396 * The type of capability interface. This is usually AlexaInterface.
3397 */
3398 'type'?: string;
3399 /**
3400 * The version of the capability interface that the endpoint supports.
3401 */
3402 'version'?: string;
3403 }
3404}
3405export declare namespace services.endpointEnumeration {
3406 /**
3407 * Contains the list of endpoints.
3408 * @interface
3409 */
3410 interface EndpointEnumerationResponse {
3411 /**
3412 * The list of endpoints.
3413 */
3414 'endpoints'?: Array<services.endpointEnumeration.EndpointInfo>;
3415 }
3416}
3417export declare namespace services.endpointEnumeration {
3418 /**
3419 * Contains the list of connected endpoints and their declared capabilities.
3420 * @interface
3421 */
3422 interface EndpointInfo {
3423 /**
3424 * A unique identifier for the endpoint.
3425 */
3426 'endpointId'?: string;
3427 /**
3428 * The name of the endpoint. Because this name might be changed by the user or the platform, it might be different than the Bluetooth friendly name.
3429 */
3430 'friendlyName'?: string;
3431 /**
3432 * The list of endpoint capabilities.
3433 */
3434 'capabilities'?: Array<services.endpointEnumeration.EndpointCapability>;
3435 }
3436}
3437export declare namespace services.endpointEnumeration {
3438 /**
3439 *
3440 * @interface
3441 */
3442 interface Error {
3443 /**
3444 * Domain specific error code.
3445 */
3446 'code'?: string;
3447 /**
3448 * Detailed error message.
3449 */
3450 'message'?: string;
3451 }
3452}
3453export declare namespace services.gadgetController {
3454 /**
3455 * The action that triggers the animation. Possible values are as follows * `buttonDown` - Play the animation when the button is pressed. * `buttonUp` - Play the animation when the button is released. * `none` - Play the animation as soon as it arrives.
3456 * @enum
3457 */
3458 type TriggerEventType = 'buttonDown' | 'buttonUp' | 'none';
3459}
3460export declare namespace services.gadgetController {
3461 /**
3462 *
3463 * @interface
3464 */
3465 interface AnimationStep {
3466 /**
3467 * The duration in milliseconds to render this step.
3468 */
3469 'durationMs': number;
3470 /**
3471 * The color to render specified in RGB hexadecimal values. There are a number of Node.js libraries available for working with color.
3472 */
3473 'color': string;
3474 /**
3475 * A boolean that indicates whether to interpolate from the previous color into this one over the course of this directive's durationMs.
3476 */
3477 'blend': boolean;
3478 }
3479}
3480export declare namespace services.gadgetController {
3481 /**
3482 *
3483 * @interface
3484 */
3485 interface LightAnimation {
3486 /**
3487 * The number of times to play this animation.
3488 */
3489 'repeat'?: number;
3490 /**
3491 * An array of strings that represent the light addresses on the target gadgets that this animation will be applied to. Because the Echo Button has one light only, use [\"1\"] to signify that this animation should be sent to light one.
3492 */
3493 'targetLights'?: Array<string>;
3494 /**
3495 * The animation steps to render in order. The maximum number of steps that you can define is 38. The minimum is 0. Each step must have the following fields, all of which are required.
3496 */
3497 'sequence'?: Array<services.gadgetController.AnimationStep>;
3498 }
3499}
3500export declare namespace services.gadgetController {
3501 /**
3502 * Arguments that pertain to animating the buttons.
3503 * @interface
3504 */
3505 interface SetLightParameters {
3506 'triggerEvent'?: services.gadgetController.TriggerEventType;
3507 'triggerEventTimeMs'?: number;
3508 'animations'?: Array<services.gadgetController.LightAnimation>;
3509 }
3510}
3511export declare namespace services.gameEngine {
3512 /**
3513 * Specifies what raw button presses to put in the inputEvents field of the event. * history - All button presses since this Input Handler was started. * matches - Just the button presses that contributed to this event (that is, were in the recognizers). To receive no raw button presses, leave this array empty or do not specify it at all.
3514 * @enum
3515 */
3516 type EventReportingType = 'history' | 'matches';
3517}
3518export declare namespace services.gameEngine {
3519 /**
3520 *
3521 * @interface
3522 */
3523 interface InputEvent {
3524 /**
3525 * The identifier of the Echo Button in question. It matches the gadgetId that you will have discovered in roll call.
3526 */
3527 'gadgetId'?: string;
3528 /**
3529 * The event's original moment of occurrence, in ISO format.
3530 */
3531 'timestamp'?: string;
3532 'action'?: services.gameEngine.InputEventActionType;
3533 /**
3534 * The hexadecimal RGB values of the button LED at the time of the event.
3535 */
3536 'color'?: string;
3537 /**
3538 * For gadgets with multiple features, this is the feature that the event represents. Echo Buttons have one feature only, so this is always `press`.
3539 */
3540 'feature'?: string;
3541 }
3542}
3543export declare namespace services.gameEngine {
3544 /**
3545 * Either \"down\" for a button pressed or \"up\" for a button released.
3546 * @enum
3547 */
3548 type InputEventActionType = 'down' | 'up';
3549}
3550export declare namespace services.gameEngine {
3551 /**
3552 *
3553 * @interface
3554 */
3555 interface InputHandlerEvent {
3556 /**
3557 * The name of the event as you defined it in your GameEngine.StartInputHandler directive.
3558 */
3559 'name'?: string;
3560 /**
3561 * A chronologically ordered report of the raw Button Events that contributed to this Input Handler Event.
3562 */
3563 'inputEvents'?: Array<services.gameEngine.InputEvent>;
3564 }
3565}
3566export declare namespace services.gameEngine {
3567 /**
3568 * Where the pattern must appear in the history of this input handler. * `start` - (Default) The first event in the pattern must be the first event in the history of raw Echo Button events. * `end` - The last event in the pattern must be the last event in the history of raw Echo Button events. * `anywhere` - The pattern may appear anywhere in the history of raw Echo Button events.
3569 * @enum
3570 */
3571 type PatternRecognizerAnchorType = 'start' | 'end' | 'anywhere';
3572}
3573export declare namespace services.gameEngine {
3574 /**
3575 * The events object is where you define the conditions that must be met for your skill to be notified of Echo Button input. You must define at least one event.
3576 * @interface
3577 */
3578 interface Event {
3579 /**
3580 * Whether the Input Handler should end after this event fires. If true, the Input Handler will stop and no further events will be sent to your skill unless you call StartInputHandler again.
3581 */
3582 'shouldEndInputHandler': boolean;
3583 'meets': Array<string>;
3584 'fails'?: Array<string>;
3585 'reports'?: services.gameEngine.EventReportingType;
3586 /**
3587 * Enables you to limit the number of times that the skill is notified about the same event during the course of the Input Handler. The default value is 1. This property is mutually exclusive with triggerTimeMilliseconds.
3588 */
3589 'maximumInvocations'?: number;
3590 /**
3591 * Adds a time constraint to the event. Instead of being considered whenever a raw button event occurs, an event that has this parameter will only be considered once at triggerTimeMilliseconds after the Input Handler has started. Because a time-triggered event can only fire once, the maximumInvocations value is ignored. Omit this property entirely if you do not want to time-constrain the event.
3592 */
3593 'triggerTimeMilliseconds'?: number;
3594 }
3595}
3596export declare namespace services.gameEngine {
3597 /**
3598 * An object that provides all of the events that need to occur, in a specific order, for this recognizer to be true. Omitting any parameters in this object means \"match anything\".
3599 * @interface
3600 */
3601 interface Pattern {
3602 /**
3603 * A whitelist of gadgetIds that are eligible for this match.
3604 */
3605 'gadgetIds'?: Array<string>;
3606 /**
3607 * A whitelist of colors that are eligible for this match.
3608 */
3609 'colors'?: Array<string>;
3610 'action'?: services.gameEngine.InputEventActionType;
3611 /**
3612 * The number of times that the specified action must occur to be considered complete.
3613 */
3614 'repeat'?: number;
3615 }
3616}
3617export declare namespace services.gameEngine {
3618 /**
3619 * Recognizers are conditions that, at any moment, are either true or false, based on all the raw button events that the Input Handler has received in the time elapsed since the Input Handler session started.
3620 * @interface
3621 */
3622 type Recognizer = services.gameEngine.PatternRecognizer | services.gameEngine.DeviationRecognizer | services.gameEngine.ProgressRecognizer;
3623}
3624export declare namespace services.listManagement {
3625 /**
3626 *
3627 * @interface
3628 */
3629 interface AlexaList {
3630 'listId'?: string;
3631 'name'?: string;
3632 'state'?: services.listManagement.ListState;
3633 'version'?: number;
3634 'items'?: Array<services.listManagement.AlexaListItem>;
3635 'links'?: services.listManagement.Links;
3636 }
3637}
3638export declare namespace services.listManagement {
3639 /**
3640 *
3641 * @interface
3642 */
3643 interface AlexaListItem {
3644 'id'?: string;
3645 'version'?: number;
3646 'value'?: string;
3647 'status'?: services.listManagement.ListItemState;
3648 'createdTime'?: string;
3649 'updatedTime'?: string;
3650 /**
3651 * URL to retrieve the item from.
3652 */
3653 'href'?: string;
3654 }
3655}
3656export declare namespace services.listManagement {
3657 /**
3658 *
3659 * @interface
3660 */
3661 interface AlexaListMetadata {
3662 'listId'?: string;
3663 'name'?: string;
3664 'state'?: services.listManagement.ListState;
3665 'version'?: number;
3666 'statusMap'?: Array<services.listManagement.Status>;
3667 }
3668}
3669export declare namespace services.listManagement {
3670 /**
3671 *
3672 * @interface
3673 */
3674 interface AlexaListsMetadata {
3675 'lists'?: Array<services.listManagement.AlexaListMetadata>;
3676 }
3677}
3678export declare namespace services.listManagement {
3679 /**
3680 *
3681 * @interface
3682 */
3683 interface CreateListItemRequest {
3684 'value'?: string;
3685 'status'?: services.listManagement.ListItemState;
3686 }
3687}
3688export declare namespace services.listManagement {
3689 /**
3690 *
3691 * @interface
3692 */
3693 interface CreateListRequest {
3694 'name'?: string;
3695 'state'?: services.listManagement.ListState;
3696 }
3697}
3698export declare namespace services.listManagement {
3699 /**
3700 *
3701 * @interface
3702 */
3703 interface Error {
3704 'type'?: string;
3705 'message'?: string;
3706 }
3707}
3708export declare namespace services.listManagement {
3709 /**
3710 *
3711 * @interface
3712 */
3713 interface ForbiddenError {
3714 'Message'?: string;
3715 }
3716}
3717export declare namespace services.listManagement {
3718 /**
3719 *
3720 * @interface
3721 */
3722 interface Links {
3723 'next'?: string;
3724 }
3725}
3726export declare namespace services.listManagement {
3727 /**
3728 *
3729 * @interface
3730 */
3731 interface ListBody {
3732 'listId'?: string;
3733 }
3734}
3735export declare namespace services.listManagement {
3736 /**
3737 *
3738 * @interface
3739 */
3740 interface ListItemBody {
3741 'listId'?: string;
3742 'listItemIds'?: Array<string>;
3743 }
3744}
3745export declare namespace services.listManagement {
3746 /**
3747 *
3748 * @enum
3749 */
3750 type ListItemState = 'active' | 'completed';
3751}
3752export declare namespace services.listManagement {
3753 /**
3754 *
3755 * @enum
3756 */
3757 type ListState = 'active' | 'archived';
3758}
3759export declare namespace services.listManagement {
3760 /**
3761 *
3762 * @interface
3763 */
3764 interface Status {
3765 'url'?: string;
3766 'status'?: services.listManagement.ListItemState;
3767 }
3768}
3769export declare namespace services.listManagement {
3770 /**
3771 *
3772 * @interface
3773 */
3774 interface UpdateListItemRequest {
3775 /**
3776 * New item value
3777 */
3778 'value'?: string;
3779 /**
3780 * Item Status
3781 */
3782 'status'?: services.listManagement.ListItemState;
3783 /**
3784 * Item version when it was read.
3785 */
3786 'version'?: number;
3787 }
3788}
3789export declare namespace services.listManagement {
3790 /**
3791 *
3792 * @interface
3793 */
3794 interface UpdateListRequest {
3795 'name'?: string;
3796 'state'?: services.listManagement.ListState;
3797 'version'?: number;
3798 }
3799}
3800export declare namespace services.monetization {
3801 /**
3802 * State determining if the user is entitled to the product. Note - Any new values introduced later should be treated as 'NOT_ENTITLED'. * 'ENTITLED' - The user is entitled to the product. * 'NOT_ENTITLED' - The user is not entitled to the product.
3803 * @enum
3804 */
3805 type EntitledState = 'ENTITLED' | 'NOT_ENTITLED';
3806}
3807export declare namespace services.monetization {
3808 /**
3809 * Reason for the entitlement status. * 'PURCHASED' - The user is entitled to the product because they purchased it directly. * 'NOT_PURCHASED' - The user is not entitled to the product because they have not purchased it. * 'AUTO_ENTITLED' - The user is auto entitled to the product because they have subscribed to a broader service. * 'BUNDLE_ENTITLED' - The user is entitled to the product because they purchased it indirectly as part of a bundle. If the user is entitled via both PURCHASED and BUNDLE_ENTITLED, then BUNDLE_ENTITLED takes priority.
3810 * @enum
3811 */
3812 type EntitlementReason = 'PURCHASED' | 'NOT_PURCHASED' | 'AUTO_ENTITLED' | 'BUNDLE_ENTITLED';
3813}
3814export declare namespace services.monetization {
3815 /**
3816 * Describes error detail
3817 * @interface
3818 */
3819 interface Error {
3820 /**
3821 * Readable description of error
3822 */
3823 'message'?: string;
3824 }
3825}
3826export declare namespace services.monetization {
3827 /**
3828 *
3829 * @interface
3830 */
3831 interface InSkillProduct {
3832 /**
3833 * Product Id
3834 */
3835 'productId': string;
3836 /**
3837 * Developer selected in-skill product name. This is for developer reference only.
3838 */
3839 'referenceName': string;
3840 /**
3841 * Name of the product in the language from the \"Accept-Language\" header
3842 */
3843 'name': string;
3844 'type': services.monetization.ProductType;
3845 /**
3846 * Product summary in the language from the \"Accept-Language\" header
3847 */
3848 'summary': string;
3849 'purchasable': services.monetization.PurchasableState;
3850 'entitled': services.monetization.EntitledState;
3851 'entitlementReason': services.monetization.EntitlementReason;
3852 /**
3853 * Total active purchases of the product made by the user. Note - For ENTITLEMENT and SUBSCRIPTION product types, the value is either zero(NOT_ENTITLED) or one(ENTITLED). For CONSUMABLE product type the value is zero or more, as CONSUMABLE can be re-purchased.
3854 */
3855 'activeEntitlementCount': number;
3856 'purchaseMode': services.monetization.PurchaseMode;
3857 }
3858}
3859export declare namespace services.monetization {
3860 /**
3861 *
3862 * @interface
3863 */
3864 interface InSkillProductTransactionsResponse {
3865 /**
3866 * List of transactions of in skill products purchases
3867 */
3868 'results': Array<services.monetization.Transactions>;
3869 'metadata': services.monetization.Metadata;
3870 }
3871}
3872export declare namespace services.monetization {
3873 /**
3874 *
3875 * @interface
3876 */
3877 interface InSkillProductsResponse {
3878 /**
3879 * List of In-Skill Products
3880 */
3881 'inSkillProducts': Array<services.monetization.InSkillProduct>;
3882 'isTruncated': boolean;
3883 'nextToken': string;
3884 }
3885}
3886export declare namespace services.monetization {
3887 /**
3888 *
3889 * @interface
3890 */
3891 interface Metadata {
3892 'resultSet'?: services.monetization.ResultSet;
3893 }
3894}
3895export declare namespace services.monetization {
3896 /**
3897 * Product type. * 'SUBSCRIPTION' - Once purchased, customers will own the content for the subscription period. * 'ENTITLEMENT' - Once purchased, customers will own the content forever. * 'CONSUMABLE' - Once purchased, customers will be entitled to the content until it is consumed. It can also be re-purchased.
3898 * @enum
3899 */
3900 type ProductType = 'SUBSCRIPTION' | 'ENTITLEMENT' | 'CONSUMABLE';
3901}
3902export declare namespace services.monetization {
3903 /**
3904 * State determining if the product is purchasable by the user. Note - Any new values introduced later should be treated as 'NOT_PURCHASABLE'. * 'PURCHASABLE' - The product is purchasable by the user. * 'NOT_PURCHASABLE' - The product is not purchasable by the user.
3905 * @enum
3906 */
3907 type PurchasableState = 'PURCHASABLE' | 'NOT_PURCHASABLE';
3908}
3909export declare namespace services.monetization {
3910 /**
3911 * Indicates if the entitlements are for TEST or LIVE purchases. * 'TEST' - test purchases made by developers or beta testers. Purchase not sent to payment processing. * 'LIVE' - purchases made by live customers. Purchase sent to payment processing.
3912 * @enum
3913 */
3914 type PurchaseMode = 'TEST' | 'LIVE';
3915}
3916export declare namespace services.monetization {
3917 /**
3918 *
3919 * @interface
3920 */
3921 interface ResultSet {
3922 'nextToken'?: string;
3923 }
3924}
3925export declare namespace services.monetization {
3926 /**
3927 * Transaction status for in skill product purchases. * 'PENDING_APPROVAL_BY_PARENT' - The transaction is pending approval from parent. * 'APPROVED_BY_PARENT' - The transaction was approved by parent and fulfilled successfully.. * 'DENIED_BY_PARENT' - The transaction was declined by parent and hence not fulfilled. * 'EXPIRED_NO_ACTION_BY_PARENT' - The transaction was expired due to no response from parent and hence not fulfilled. * 'ERROR' - The transaction was not fullfiled as there was an error while processing the transaction.
3928 * @enum
3929 */
3930 type Status = 'PENDING_APPROVAL_BY_PARENT' | 'APPROVED_BY_PARENT' | 'DENIED_BY_PARENT' | 'EXPIRED_NO_ACTION_BY_PARENT' | 'ERROR';
3931}
3932export declare namespace services.monetization {
3933 /**
3934 *
3935 * @interface
3936 */
3937 interface Transactions {
3938 'status'?: services.monetization.Status;
3939 /**
3940 * Product Id
3941 */
3942 'productId'?: string;
3943 /**
3944 * Time at which transaction's was initiated in ISO 8601 format i.e. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
3945 */
3946 'createdTime'?: string;
3947 /**
3948 * Time at which transaction's status was last updated in ISO 8601 format i.e. yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
3949 */
3950 'lastModifiedTime'?: string;
3951 }
3952}
3953export declare namespace services.proactiveEvents {
3954 /**
3955 *
3956 * @interface
3957 */
3958 interface CreateProactiveEventRequest {
3959 /**
3960 * The date and time of the event associated with this request, in ISO 8601 format.
3961 */
3962 'timestamp': string;
3963 /**
3964 * Client-supplied ID for correlating the event with external entities. The allowed characters for the referenceId field are alphanumeric and ~, and the length of the referenceId field must be 1-100 characters.
3965 */
3966 'referenceId': string;
3967 /**
3968 * The date and time, in ISO 8601 format, when the service will automatically delete the notification if it is still in the pending state.
3969 */
3970 'expiryTime': string;
3971 'event': services.proactiveEvents.Event;
3972 /**
3973 * A list of items, each of which contains the set of event attributes that requires localization support.
3974 */
3975 'localizedAttributes': Array<any>;
3976 'relevantAudience': services.proactiveEvents.RelevantAudience;
3977 }
3978}
3979export declare namespace services.proactiveEvents {
3980 /**
3981 *
3982 * @interface
3983 */
3984 interface Error {
3985 'code'?: number;
3986 'message'?: string;
3987 }
3988}
3989export declare namespace services.proactiveEvents {
3990 /**
3991 * The event data to be sent to customers, conforming to the schema associated with this event.
3992 * @interface
3993 */
3994 interface Event {
3995 'name': string;
3996 'payload': any;
3997 }
3998}
3999export declare namespace services.proactiveEvents {
4000 /**
4001 * The audience for this event.
4002 * @interface
4003 */
4004 interface RelevantAudience {
4005 'type': services.proactiveEvents.RelevantAudienceType;
4006 /**
4007 * If relevantAudience.type is set to Multicast, then the payload object is empty. Otherwise, the userId value for which the event is targeted is required.
4008 */
4009 'payload': any;
4010 }
4011}
4012export declare namespace services.proactiveEvents {
4013 /**
4014 * The audience for this event. Use Multicast to target information to all customers subscribed to that event, or use Unicast to target information containing the actual userId for individual events.
4015 * @enum
4016 */
4017 type RelevantAudienceType = 'Unicast' | 'Multicast';
4018}
4019export declare namespace services.proactiveEvents {
4020 /**
4021 * Stage for creating Proactive events. Since proactive events can be created on the DEVELOPMENT and LIVE stages of the skill, this enum provides the stage values that can be used to pass to the service call.
4022 * @enum
4023 */
4024 type SkillStage = 'DEVELOPMENT' | 'LIVE';
4025}
4026export declare namespace services.reminderManagement {
4027 /**
4028 *
4029 * @interface
4030 */
4031 interface Error {
4032 /**
4033 * Domain specific error code
4034 */
4035 'code'?: string;
4036 /**
4037 * Detailed error message
4038 */
4039 'message'?: string;
4040 }
4041}
4042export declare namespace services.reminderManagement {
4043 /**
4044 *
4045 * @interface
4046 */
4047 interface Event {
4048 'status'?: services.reminderManagement.Status;
4049 'alertToken'?: string;
4050 }
4051}
4052export declare namespace services.reminderManagement {
4053 /**
4054 * Response object for get reminders request
4055 * @interface
4056 */
4057 interface GetRemindersResponse {
4058 /**
4059 * Total count of reminders returned
4060 */
4061 'totalCount'?: string;
4062 /**
4063 * List of reminders
4064 */
4065 'alerts'?: Array<services.reminderManagement.Reminder>;
4066 /**
4067 * Link to retrieve next set of alerts if total count is greater than max results
4068 */
4069 'links'?: string;
4070 }
4071}
4072export declare namespace services.reminderManagement {
4073 /**
4074 * Reminder object
4075 * @interface
4076 */
4077 interface Reminder {
4078 /**
4079 * Unique id of this reminder alert
4080 */
4081 'alertToken'?: string;
4082 /**
4083 * Valid ISO 8601 format - Creation time of this reminder alert
4084 */
4085 'createdTime'?: string;
4086 /**
4087 * Valid ISO 8601 format - Last updated time of this reminder alert
4088 */
4089 'updatedTime'?: string;
4090 'status'?: services.reminderManagement.Status;
4091 'trigger'?: services.reminderManagement.Trigger;
4092 'alertInfo'?: services.reminderManagement.AlertInfo;
4093 'pushNotification'?: services.reminderManagement.PushNotification;
4094 /**
4095 * Version of reminder alert
4096 */
4097 'version'?: string;
4098 }
4099}
4100export declare namespace services.reminderManagement {
4101 /**
4102 *
4103 * @interface
4104 */
4105 interface ReminderDeletedEvent {
4106 'alertTokens'?: Array<string>;
4107 }
4108}
4109export declare namespace services.reminderManagement {
4110 /**
4111 * Input request for creating a reminder
4112 * @interface
4113 */
4114 interface ReminderRequest {
4115 /**
4116 * Valid ISO 8601 format - Creation time of this reminder alert
4117 */
4118 'requestTime'?: string;
4119 'trigger'?: services.reminderManagement.Trigger;
4120 'alertInfo'?: services.reminderManagement.AlertInfo;
4121 'pushNotification'?: services.reminderManagement.PushNotification;
4122 }
4123}
4124export declare namespace services.reminderManagement {
4125 /**
4126 * Response object for post/put/delete reminder request
4127 * @interface
4128 */
4129 interface ReminderResponse {
4130 /**
4131 * Unique id of this reminder alert
4132 */
4133 'alertToken'?: string;
4134 /**
4135 * Valid ISO 8601 format - Creation time of this reminder alert
4136 */
4137 'createdTime'?: string;
4138 /**
4139 * Valid ISO 8601 format - Last updated time of this reminder alert
4140 */
4141 'updatedTime'?: string;
4142 'status'?: services.reminderManagement.Status;
4143 /**
4144 * Version of reminder alert
4145 */
4146 'version'?: string;
4147 /**
4148 * URI to retrieve the created alert
4149 */
4150 'href'?: string;
4151 }
4152}
4153export declare namespace services.reminderManagement {
4154 /**
4155 * Alert info for VUI / GUI
4156 * @interface
4157 */
4158 interface AlertInfo {
4159 'spokenInfo'?: services.reminderManagement.SpokenInfo;
4160 }
4161}
4162export declare namespace services.reminderManagement {
4163 /**
4164 * Enable / disable reminders push notifications to Alexa mobile apps
4165 * @interface
4166 */
4167 interface PushNotification {
4168 'status'?: services.reminderManagement.PushNotificationStatus;
4169 }
4170}
4171export declare namespace services.reminderManagement {
4172 /**
4173 * Push notification status - Enabled/Disabled
4174 * @enum
4175 */
4176 type PushNotificationStatus = 'ENABLED' | 'DISABLED';
4177}
4178export declare namespace services.reminderManagement {
4179 /**
4180 * Recurring date/time using the RFC 5545 standard in JSON object form
4181 * @interface
4182 */
4183 interface Recurrence {
4184 'freq'?: services.reminderManagement.RecurrenceFreq;
4185 'byDay'?: Array<services.reminderManagement.RecurrenceDay>;
4186 /**
4187 * contains a positive integer representing at which intervals the recurrence rule repeats
4188 */
4189 'interval'?: number;
4190 /**
4191 * Valid ISO 8601 format - optional start DateTime of recurrence.
4192 */
4193 'startDateTime'?: string;
4194 /**
4195 * Valid ISO 8601 format - optional end DateTime of recurrence
4196 */
4197 'endDateTime'?: string;
4198 'recurrenceRules'?: Array<string>;
4199 }
4200}
4201export declare namespace services.reminderManagement {
4202 /**
4203 * Day of recurrence. Deprecated.
4204 * @enum
4205 */
4206 type RecurrenceDay = 'SU' | 'MO' | 'TU' | 'WE' | 'TH' | 'FR' | 'SA';
4207}
4208export declare namespace services.reminderManagement {
4209 /**
4210 * Frequency of recurrence. Deprecated.
4211 * @enum
4212 */
4213 type RecurrenceFreq = 'WEEKLY' | 'DAILY';
4214}
4215export declare namespace services.reminderManagement {
4216 /**
4217 * Parameters for VUI presentation of the reminder
4218 * @interface
4219 */
4220 interface SpokenInfo {
4221 'content': Array<services.reminderManagement.SpokenText>;
4222 }
4223}
4224export declare namespace services.reminderManagement {
4225 /**
4226 *
4227 * @interface
4228 */
4229 interface SpokenText {
4230 /**
4231 * The locale in which the spoken text is rendered. e.g. en-US
4232 */
4233 'locale'?: string;
4234 /**
4235 * Spoken text in SSML format.
4236 */
4237 'ssml'?: string;
4238 /**
4239 * Spoken text in plain text format.
4240 */
4241 'text'?: string;
4242 }
4243}
4244export declare namespace services.reminderManagement {
4245 /**
4246 * Status of reminder
4247 * @enum
4248 */
4249 type Status = 'ON' | 'COMPLETED';
4250}
4251export declare namespace services.reminderManagement {
4252 /**
4253 * Trigger information for Reminder
4254 * @interface
4255 */
4256 interface Trigger {
4257 'type'?: services.reminderManagement.TriggerType;
4258 /**
4259 * Valid ISO 8601 format - Intended trigger time
4260 */
4261 'scheduledTime'?: string;
4262 /**
4263 * If reminder is set using relative time, use this field to specify the time after which reminder ll ring (in seconds)
4264 */
4265 'offsetInSeconds'?: number;
4266 /**
4267 * Intended reminder's timezone
4268 */
4269 'timeZoneId'?: string;
4270 'recurrence'?: services.reminderManagement.Recurrence;
4271 }
4272}
4273export declare namespace services.reminderManagement {
4274 /**
4275 * Type of reminder - Absolute / Relative
4276 * @enum
4277 */
4278 type TriggerType = 'SCHEDULED_ABSOLUTE' | 'SCHEDULED_RELATIVE';
4279}
4280export declare namespace services.skillMessaging {
4281 /**
4282 *
4283 * @interface
4284 */
4285 interface Error {
4286 'code'?: number;
4287 'message'?: string;
4288 }
4289}
4290export declare namespace services.skillMessaging {
4291 /**
4292 * The message that needs to be sent to the skill
4293 * @interface
4294 */
4295 interface SendSkillMessagingRequest {
4296 /**
4297 * The payload data to send with the message. The data must be in the form of JSON-formatted key-value pairs. Both keys and values must be of type String. The total size of the data cannot be greater than 6KB. For calculation purposes, this includes keys and values, the quotes that surround them, the \":\" character that separates them, the commas that separate the pairs, and the opening and closing braces around the field. However, any whitespace between key/value pairs is not included in the calculation of the payload size. If the message does not include payload data, as in the case of a sync message, you can pass in an empty JSON object \"{}\".
4298 */
4299 'data': any;
4300 /**
4301 * The number of seconds that the message will be retained to retry if message delivery is not successful. Allowed values are from 60 (1 minute) to 86400 (1 day), inclusive. The default is 3600 (1 hour). Multiple retries may occur during this interval. The retry logic is exponential. The first retry executes after 30 seconds, and this time period doubles on every retry. The retries will end when the total time elapsed since the message was first sent has exceeded the value you provided for expiresAfterSeconds. Message expiry is rarely a problem if the message handler has been set up correctly. With a correct setup, you will receive the message once promptly. This mechanism for retries is provided as a safeguard in case your skill goes down during a message delivery.
4302 */
4303 'expiresAfterSeconds'?: number;
4304 }
4305}
4306export declare namespace services.timerManagement {
4307 /**
4308 * Whether the native Timer GUI is shown for 8-seconds upon Timer Creation.
4309 * @interface
4310 */
4311 interface CreationBehavior {
4312 'displayExperience'?: services.timerManagement.DisplayExperience;
4313 }
4314}
4315export declare namespace services.timerManagement {
4316 /**
4317 * Multi model presentation of the timer creation.
4318 * @interface
4319 */
4320 interface DisplayExperience {
4321 'visibility'?: services.timerManagement.Visibility;
4322 }
4323}
4324export declare namespace services.timerManagement {
4325 /**
4326 * Error object for Response.
4327 * @interface
4328 */
4329 interface Error {
4330 /**
4331 * Domain specific error code
4332 */
4333 'code'?: string;
4334 /**
4335 * Detailed error message
4336 */
4337 'message'?: string;
4338 }
4339}
4340export declare namespace services.timerManagement {
4341 /**
4342 * notification of the timer expiration.
4343 * @interface
4344 */
4345 interface NotificationConfig {
4346 /**
4347 * Whether the native trigger CX is employed for this timer. By extension, this also denote whether an explicit ‘Stop’ is required.
4348 */
4349 'playAudible'?: boolean;
4350 }
4351}
4352export declare namespace services.timerManagement {
4353 /**
4354 * Triggering information for Timer.
4355 * @interface
4356 */
4357 type Operation = services.timerManagement.LaunchTaskOperation | services.timerManagement.AnnounceOperation | services.timerManagement.NotifyOnlyOperation;
4358}
4359export declare namespace services.timerManagement {
4360 /**
4361 * Status of timer
4362 * @enum
4363 */
4364 type Status = 'ON' | 'PAUSED' | 'OFF';
4365}
4366export declare namespace services.timerManagement {
4367 /**
4368 * Custom task passed by skill developers when the operation type is \"LAUNCH_TASK\"
4369 * @interface
4370 */
4371 interface Task {
4372 /**
4373 * task name
4374 */
4375 'name'?: string;
4376 /**
4377 * task version E.g. \"1\"
4378 */
4379 'version'?: string;
4380 /**
4381 * Developers can pass in any dictionary they need for the skill
4382 */
4383 'input'?: any;
4384 }
4385}
4386export declare namespace services.timerManagement {
4387 /**
4388 * When the operation type is \"ANNOUNCE\", announces a certain text that the developer wants to be read out at the expiration of the timer.
4389 * @interface
4390 */
4391 interface TextToAnnounce {
4392 /**
4393 * The locale in which the announcement text is rendered.
4394 */
4395 'locale'?: string;
4396 /**
4397 * If provided, triggerText will be delivered by Timers speechlet upon trigger dismissal or immediately upon timer expiry if playAudible = false.
4398 */
4399 'text'?: string;
4400 }
4401}
4402export declare namespace services.timerManagement {
4403 /**
4404 * When the operation type is \"LAUNCH_TASK\", confirm with the customer at the expiration of the timer.
4405 * @interface
4406 */
4407 interface TextToConfirm {
4408 /**
4409 * The locale in which the confirmation text is rendered.
4410 */
4411 'locale'?: string;
4412 /**
4413 * Prompt will be given to user upon trigger dismissal or timer expiry (depending on playAudible). %s (placeholder for “continue with Skill Name”) is mandatory.
4414 */
4415 'text'?: string;
4416 }
4417}
4418export declare namespace services.timerManagement {
4419 /**
4420 * Input request for creating a timer.
4421 * @interface
4422 */
4423 interface TimerRequest {
4424 /**
4425 * An ISO-8601 representation of duration. E.g. for 2 minutes and 3 seconds - \"PT2M3S\".
4426 */
4427 'duration': string;
4428 /**
4429 * Label of this timer alert, maximum of 256 characters.
4430 */
4431 'timerLabel'?: string;
4432 'creationBehavior': services.timerManagement.CreationBehavior;
4433 'triggeringBehavior': services.timerManagement.TriggeringBehavior;
4434 }
4435}
4436export declare namespace services.timerManagement {
4437 /**
4438 * Timer object
4439 * @interface
4440 */
4441 interface TimerResponse {
4442 /**
4443 * Unique id of this timer alert
4444 */
4445 'id'?: string;
4446 'status'?: services.timerManagement.Status;
4447 /**
4448 * An ISO-8601 representation of duration. E.g. for 2 minutes and 3 seconds - \"PT2M3S\".
4449 */
4450 'duration'?: string;
4451 /**
4452 * Valid ISO 8601 format - Trigger time of this timer alert.
4453 */
4454 'triggerTime'?: string;
4455 /**
4456 * Label of this timer alert, maximum of 256 character.
4457 */
4458 'timerLabel'?: string;
4459 /**
4460 * Valid ISO 8601 format - Creation time of this timer alert.
4461 */
4462 'createdTime'?: string;
4463 /**
4464 * Valid ISO 8601 format - Last updated time of this timer alert.
4465 */
4466 'updatedTime'?: string;
4467 /**
4468 * An ISO-8601 representation of duration remaining since the timer was last paused. E.g. for 1 hour, 3 minutes and 31 seconds - \"PT1H3M31S\".
4469 */
4470 'remainingTimeWhenPaused'?: string;
4471 }
4472}
4473export declare namespace services.timerManagement {
4474 /**
4475 * Timers object with paginated list of multiple timers
4476 * @interface
4477 */
4478 interface TimersResponse {
4479 /**
4480 * Total count of timers returned.
4481 */
4482 'totalCount'?: number;
4483 /**
4484 * List of multiple Timer objects
4485 */
4486 'timers'?: Array<services.timerManagement.TimerResponse>;
4487 /**
4488 * Link to retrieve next set of timers if total count is greater than max results.
4489 */
4490 'nextToken'?: string;
4491 }
4492}
4493export declare namespace services.timerManagement {
4494 /**
4495 * The triggering behavior upon Timer Expired.
4496 * @interface
4497 */
4498 interface TriggeringBehavior {
4499 'operation'?: services.timerManagement.Operation;
4500 'notificationConfig'?: services.timerManagement.NotificationConfig;
4501 }
4502}
4503export declare namespace services.timerManagement {
4504 /**
4505 * The default native Timer GUI \"visible\" is shown for 8-seconds upon Timer Creation. Otherwise, \"hidden\" will not show default native Timer GUI.
4506 * @enum
4507 */
4508 type Visibility = 'VISIBLE' | 'HIDDEN';
4509}
4510export declare namespace services.ups {
4511 /**
4512 *
4513 * @enum
4514 */
4515 type DistanceUnits = 'METRIC' | 'IMPERIAL';
4516}
4517export declare namespace services.ups {
4518 /**
4519 *
4520 * @interface
4521 */
4522 interface Error {
4523 'code'?: services.ups.ErrorCode;
4524 /**
4525 * A human readable description of error.
4526 */
4527 'message'?: string;
4528 }
4529}
4530export declare namespace services.ups {
4531 /**
4532 * A more precise error code. Some of these codes may not apply to some APIs. - INVALID_KEY: the setting key is not supported - INVALID_VALUE: the setting value is not valid - INVALID_TOKEN: the token is invalid - INVALID_URI: the uri is invalid - DEVICE_UNREACHABLE: the device is offline - UNKNOWN_ERROR: internal service error
4533 * @enum
4534 */
4535 type ErrorCode = 'INVALID_KEY' | 'INVALID_VALUE' | 'INVALID_TOKEN' | 'INVALID_URI' | 'DEVICE_UNREACHABLE' | 'UNKNOWN_ERROR';
4536}
4537export declare namespace services.ups {
4538 /**
4539 *
4540 * @interface
4541 */
4542 interface PhoneNumber {
4543 'countryCode'?: string;
4544 'phoneNumber'?: string;
4545 }
4546}
4547export declare namespace services.ups {
4548 /**
4549 *
4550 * @enum
4551 */
4552 type TemperatureUnit = 'CELSIUS' | 'FAHRENHEIT';
4553}
4554export declare namespace slu.entityresolution {
4555 /**
4556 * Represents a possible authority for entity resolution
4557 * @interface
4558 */
4559 interface Resolution {
4560 'authority': string;
4561 'status': slu.entityresolution.Status;
4562 'values': Array<slu.entityresolution.ValueWrapper>;
4563 }
4564}
4565export declare namespace slu.entityresolution {
4566 /**
4567 * Represents the results of resolving the words captured from the user's utterance. This is included for slots that use a custom slot type or a built-in slot type that you have extended with your own values. Note that resolutions is not included for built-in slot types that you have not extended.
4568 * @interface
4569 */
4570 interface Resolutions {
4571 'resolutionsPerAuthority'?: Array<slu.entityresolution.Resolution>;
4572 }
4573}
4574export declare namespace slu.entityresolution {
4575 /**
4576 *
4577 * @interface
4578 */
4579 interface Status {
4580 /**
4581 * Indication of the results of attempting to resolve the user utterance against the defined slot types.
4582 */
4583 'code': slu.entityresolution.StatusCode;
4584 }
4585}
4586export declare namespace slu.entityresolution {
4587 /**
4588 * Indication of the results of attempting to resolve the user utterance against the defined slot types.
4589 * @enum
4590 */
4591 type StatusCode = 'ER_SUCCESS_MATCH' | 'ER_SUCCESS_NO_MATCH' | 'ER_ERROR_TIMEOUT' | 'ER_ERROR_EXCEPTION';
4592}
4593export declare namespace slu.entityresolution {
4594 /**
4595 * Represents the resolved value for the slot, based on the user’s utterance and slot type definition.
4596 * @interface
4597 */
4598 interface Value {
4599 /**
4600 * The name for the resolution value.
4601 */
4602 'name': string;
4603 /**
4604 * The id for the resolution value.
4605 */
4606 'id': string;
4607 }
4608}
4609export declare namespace slu.entityresolution {
4610 /**
4611 * A wrapper class for an entity resolution value used for JSON serialization.
4612 * @interface
4613 */
4614 interface ValueWrapper {
4615 'value': slu.entityresolution.Value;
4616 }
4617}
4618export declare namespace ui {
4619 /**
4620 *
4621 * @interface
4622 */
4623 type Card = ui.AskForPermissionsConsentCard | ui.LinkAccountCard | ui.StandardCard | ui.SimpleCard;
4624}
4625export declare namespace ui {
4626 /**
4627 *
4628 * @interface
4629 */
4630 interface Image {
4631 'smallImageUrl'?: string;
4632 'largeImageUrl'?: string;
4633 }
4634}
4635export declare namespace ui {
4636 /**
4637 *
4638 * @interface
4639 */
4640 type OutputSpeech = ui.SsmlOutputSpeech | ui.PlainTextOutputSpeech;
4641}
4642export declare namespace ui {
4643 /**
4644 * Determines whether Alexa will queue or play this output speech immediately interrupting other speech
4645 * @enum
4646 */
4647 type PlayBehavior = 'ENQUEUE' | 'REPLACE_ALL' | 'REPLACE_ENQUEUED';
4648}
4649export declare namespace ui {
4650 /**
4651 *
4652 * @interface
4653 */
4654 interface Reprompt {
4655 'outputSpeech'?: ui.OutputSpeech;
4656 'directives'?: Array<Directive>;
4657 }
4658}
4659/**
4660 * Represents the status and result needed to resume a skill's suspended session.
4661 * @interface
4662 */
4663export interface ConnectionCompleted {
4664 'type': 'ConnectionCompleted';
4665 /**
4666 * This is an echo back string that skills send when during Connections.StartConnection directive. They will receive it when they get the SessionResumedRequest. It is never sent to the skill handling the request.
4667 */
4668 'token'?: string;
4669 'status'?: Status;
4670 /**
4671 * This is the result object to resume the skill's suspended session.
4672 */
4673 'result'?: any;
4674}
4675/**
4676 * An IntentRequest is an object that represents a request made to a skill based on what the user wants to do.
4677 * @interface
4678 */
4679export interface IntentRequest {
4680 'type': 'IntentRequest';
4681 /**
4682 * Represents the unique identifier for the specific request.
4683 */
4684 'requestId': string;
4685 /**
4686 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
4687 */
4688 'timestamp': string;
4689 /**
4690 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
4691 */
4692 'locale'?: string;
4693 /**
4694 * Enumeration indicating the status of the multi-turn dialog. This property is included if the skill meets the requirements to use the Dialog directives. Note that COMPLETED is only possible when you use the Dialog.Delegate directive. If you use intent confirmation, dialogState is considered COMPLETED if the user denies the entire intent (for instance, by answering “no” when asked the confirmation prompt). Be sure to also check the confirmationStatus property on the Intent object before fulfilling the user’s request.
4695 */
4696 'dialogState': DialogState;
4697 /**
4698 * An object that represents what the user wants.
4699 */
4700 'intent': Intent;
4701}
4702/**
4703 * Represents that a user made a request to an Alexa skill, but did not provide a specific intent.
4704 * @interface
4705 */
4706export interface LaunchRequest {
4707 'type': 'LaunchRequest';
4708 /**
4709 * Represents the unique identifier for the specific request.
4710 */
4711 'requestId': string;
4712 /**
4713 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
4714 */
4715 'timestamp': string;
4716 /**
4717 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
4718 */
4719 'locale'?: string;
4720 'task'?: Task;
4721}
4722/**
4723 * Slot value containing a list of other slot value objects.
4724 * @interface
4725 */
4726export interface ListSlotValue {
4727 'type': 'List';
4728 /**
4729 * An array containing the values captured for this slot.
4730 */
4731 'values': Array<SlotValue>;
4732}
4733/**
4734 * A SessionEndedRequest is an object that represents a request made to an Alexa skill to notify that a session was ended. Your service receives a SessionEndedRequest when a currently open session is closed for one of the following reasons: <ol><li>The user says “exit”</li><li>the user does not respond or says something that does not match an intent defined in your voice interface while the device is listening for the user’s response</li><li>an error occurs</li></ol>
4735 * @interface
4736 */
4737export interface SessionEndedRequest {
4738 'type': 'SessionEndedRequest';
4739 /**
4740 * Represents the unique identifier for the specific request.
4741 */
4742 'requestId': string;
4743 /**
4744 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
4745 */
4746 'timestamp': string;
4747 /**
4748 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
4749 */
4750 'locale'?: string;
4751 /**
4752 * Describes why the session ended.
4753 */
4754 'reason': SessionEndedReason;
4755 /**
4756 * An error object providing more information about the error that occurred.
4757 */
4758 'error'?: SessionEndedError;
4759}
4760/**
4761 * The request to resume a skill's session and tells the skill why it is resumed.
4762 * @interface
4763 */
4764export interface SessionResumedRequest {
4765 'type': 'SessionResumedRequest';
4766 /**
4767 * Represents the unique identifier for the specific request.
4768 */
4769 'requestId': string;
4770 /**
4771 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
4772 */
4773 'timestamp': string;
4774 /**
4775 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
4776 */
4777 'locale'?: string;
4778 'cause'?: Cause;
4779}
4780/**
4781 * Slot value containing a single string value and resolutions.
4782 * @interface
4783 */
4784export interface SimpleSlotValue {
4785 'type': 'Simple';
4786 /**
4787 * A string that represents the value the user spoke for the slot. This is the actual value the user spoke, not necessarily the canonical value or one of the synonyms defined for the entity. Note that AMAZON.LITERAL slot values sent to your service are always in all lower case.
4788 */
4789 'value'?: string;
4790 /**
4791 * Contains the results of entity resolution. These are organized by authority. An authority represents the source for the data provided for the slot. For a custom slot type, the authority is the slot type you defined.
4792 */
4793 'resolutions'?: slu.entityresolution.Resolutions;
4794}
4795export declare namespace authorization {
4796 /**
4797 * Represents an authorization code delivered to a skill that has out-of-session permissions without requiring account linking.
4798 * @interface
4799 */
4800 interface AuthorizationGrantRequest {
4801 'type': 'Alexa.Authorization.Grant';
4802 /**
4803 * Represents the unique identifier for the specific request.
4804 */
4805 'requestId': string;
4806 /**
4807 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
4808 */
4809 'timestamp': string;
4810 /**
4811 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
4812 */
4813 'locale'?: string;
4814 'body': authorization.AuthorizationGrantBody;
4815 }
4816}
4817export declare namespace canfulfill {
4818 /**
4819 * An object that represents a request made to skill to query whether the skill can understand and fulfill the intent request with detected slots, before actually asking the skill to take action. Skill should be aware this is not to actually take action, skill should handle this request without causing side-effect, skill should not modify some state outside its scope or has an observable interaction with its calling functions or the outside world besides returning a value, such as playing sound,turning on/off lights, committing a transaction or a charge.
4820 * @interface
4821 */
4822 interface CanFulfillIntentRequest {
4823 'type': 'CanFulfillIntentRequest';
4824 /**
4825 * Represents the unique identifier for the specific request.
4826 */
4827 'requestId': string;
4828 /**
4829 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
4830 */
4831 'timestamp': string;
4832 /**
4833 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
4834 */
4835 'locale'?: string;
4836 'dialogState'?: DialogState;
4837 'intent': Intent;
4838 }
4839}
4840export declare namespace dialog {
4841 /**
4842 *
4843 * @interface
4844 */
4845 interface ConfirmIntentDirective {
4846 'type': 'Dialog.ConfirmIntent';
4847 'updatedIntent'?: Intent;
4848 }
4849}
4850export declare namespace dialog {
4851 /**
4852 *
4853 * @interface
4854 */
4855 interface ConfirmSlotDirective {
4856 'type': 'Dialog.ConfirmSlot';
4857 'updatedIntent'?: Intent;
4858 'slotToConfirm': string;
4859 }
4860}
4861export declare namespace dialog {
4862 /**
4863 *
4864 * @interface
4865 */
4866 interface DelegateDirective {
4867 'type': 'Dialog.Delegate';
4868 'updatedIntent'?: Intent;
4869 }
4870}
4871export declare namespace dialog {
4872 /**
4873 *
4874 * @interface
4875 */
4876 interface DelegateRequestDirective {
4877 'type': 'Dialog.DelegateRequest';
4878 /**
4879 * The delegation target.
4880 */
4881 'target': string;
4882 'period': dialog.DelegationPeriod;
4883 'updatedRequest'?: dialog.UpdatedRequest;
4884 }
4885}
4886export declare namespace dialog {
4887 /**
4888 *
4889 * @interface
4890 */
4891 interface DynamicEntitiesDirective {
4892 'type': 'Dialog.UpdateDynamicEntities';
4893 'updateBehavior': er.dynamic.UpdateBehavior;
4894 'types'?: Array<er.dynamic.EntityListItem>;
4895 }
4896}
4897export declare namespace dialog {
4898 /**
4899 *
4900 * @interface
4901 */
4902 interface ElicitSlotDirective {
4903 'type': 'Dialog.ElicitSlot';
4904 'updatedIntent'?: Intent;
4905 'slotToElicit': string;
4906 }
4907}
4908export declare namespace dialog {
4909 /**
4910 * A request representing structured data used to provide dialog input to a dialog manager.
4911 * @interface
4912 */
4913 interface InputRequest {
4914 'type': 'Dialog.InputRequest';
4915 /**
4916 * Represents the unique identifier for the specific request.
4917 */
4918 'requestId': string;
4919 /**
4920 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
4921 */
4922 'timestamp': string;
4923 /**
4924 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
4925 */
4926 'locale'?: string;
4927 'input': dialog.Input;
4928 }
4929}
4930export declare namespace dialog {
4931 /**
4932 *
4933 * @interface
4934 */
4935 interface UpdatedInputRequest {
4936 'type': 'Dialog.InputRequest';
4937 'input': dialog.Input;
4938 }
4939}
4940export declare namespace dialog {
4941 /**
4942 *
4943 * @interface
4944 */
4945 interface UpdatedIntentRequest {
4946 'type': 'IntentRequest';
4947 'intent': Intent;
4948 }
4949}
4950export declare namespace dynamicEndpoints {
4951 /**
4952 * Failure skill response for a Dynamic endpoint request.
4953 * @interface
4954 */
4955 interface FailureResponse {
4956 'type': 'SkillResponseFailureMessage';
4957 /**
4958 * The version of the response message schema used.
4959 */
4960 'version': string;
4961 /**
4962 * The same request identifier as the Dynamic endpoint request for this response.
4963 */
4964 'originalRequestId': string;
4965 /**
4966 * The error code for the failure. Standard HTTP error codes will be used.
4967 */
4968 'errorCode'?: string;
4969 /**
4970 * Description of the failure.
4971 */
4972 'errorMessage'?: string;
4973 }
4974}
4975export declare namespace dynamicEndpoints {
4976 /**
4977 * Success response for a Dynamic endpoint request.
4978 * @interface
4979 */
4980 interface SuccessResponse {
4981 'type': 'SkillResponseSuccessMessage';
4982 /**
4983 * The version of the response message schema used.
4984 */
4985 'version': string;
4986 /**
4987 * The same request identifier as the Dynamic endpoint request for this response.
4988 */
4989 'originalRequestId': string;
4990 /**
4991 * The response payload.
4992 */
4993 'responsePayload'?: string;
4994 }
4995}
4996export declare namespace events.skillevents {
4997 /**
4998 * This event indicates that a customer has linked an account in a third-party application with the Alexa app. This event is useful for an application that support out-of-session (non-voice) user interactions so that this application can be notified when the internal customer can be associated with the Alexa customer. This event is required for many applications that synchronize customer Alexa lists with application lists. During the account linking process, the Alexa app directs the user to the skill website where the customer logs in. When the customer logs in, the skill then provides an access token and a consent token to Alexa. The event includes the same access token and consent token.
4999 * @interface
5000 */
5001 interface AccountLinkedRequest {
5002 'type': 'AlexaSkillEvent.SkillAccountLinked';
5003 /**
5004 * Represents the unique identifier for the specific request.
5005 */
5006 'requestId': string;
5007 /**
5008 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5009 */
5010 'timestamp': string;
5011 /**
5012 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5013 */
5014 'locale'?: string;
5015 'body': events.skillevents.AccountLinkedBody;
5016 'eventCreationTime'?: string;
5017 'eventPublishingTime'?: string;
5018 }
5019}
5020export declare namespace events.skillevents {
5021 /**
5022 * When a customer changes his topic subscriptions Alexa will send an event back to the skill endpoint notifying the skill owner with the most recent state of the customer's subscriptions. This is to notify skill owners of customers' interest in receiving events from one or more schemas. This event indicates a customer permission to receive notifications from your skill and contains information for that user. You need this information to know the userId in order to send notifications to individual users. Note that these events can arrive out of order, so ensure that your skill service uses the timestamp in the event to correctly record the latest topic subscription state for a customer.
5023 * @interface
5024 */
5025 interface NotificationSubscriptionChangedRequest {
5026 'type': 'AlexaSkillEvent.NotificationSubscriptionChanged';
5027 /**
5028 * Represents the unique identifier for the specific request.
5029 */
5030 'requestId': string;
5031 /**
5032 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5033 */
5034 'timestamp': string;
5035 /**
5036 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5037 */
5038 'locale'?: string;
5039 'body': events.skillevents.NotificationSubscriptionChangedBody;
5040 }
5041}
5042export declare namespace events.skillevents {
5043 /**
5044 *
5045 * @interface
5046 */
5047 interface PermissionAcceptedRequest {
5048 'type': 'AlexaSkillEvent.SkillPermissionAccepted';
5049 /**
5050 * Represents the unique identifier for the specific request.
5051 */
5052 'requestId': string;
5053 /**
5054 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5055 */
5056 'timestamp': string;
5057 /**
5058 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5059 */
5060 'locale'?: string;
5061 'body'?: events.skillevents.PermissionBody;
5062 'eventCreationTime'?: string;
5063 'eventPublishingTime'?: string;
5064 }
5065}
5066export declare namespace events.skillevents {
5067 /**
5068 *
5069 * @interface
5070 */
5071 interface PermissionChangedRequest {
5072 'type': 'AlexaSkillEvent.SkillPermissionChanged';
5073 /**
5074 * Represents the unique identifier for the specific request.
5075 */
5076 'requestId': string;
5077 /**
5078 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5079 */
5080 'timestamp': string;
5081 /**
5082 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5083 */
5084 'locale'?: string;
5085 'body'?: events.skillevents.PermissionBody;
5086 'eventCreationTime'?: string;
5087 'eventPublishingTime'?: string;
5088 }
5089}
5090export declare namespace events.skillevents {
5091 /**
5092 * This event indicates a customer subscription to receive events from your skill and contains information for that user and person, if recognized. You need this information to know the userId and personId in order to send events to individual users. Note that these events can arrive out of order, so ensure that your skill service uses the timestamp in the event to correctly record the latest subscription state for a customer.
5093 * @interface
5094 */
5095 interface ProactiveSubscriptionChangedRequest {
5096 'type': 'AlexaSkillEvent.ProactiveSubscriptionChanged';
5097 /**
5098 * Represents the unique identifier for the specific request.
5099 */
5100 'requestId': string;
5101 /**
5102 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5103 */
5104 'timestamp': string;
5105 /**
5106 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5107 */
5108 'locale'?: string;
5109 'body': events.skillevents.ProactiveSubscriptionChangedBody;
5110 }
5111}
5112export declare namespace events.skillevents {
5113 /**
5114 *
5115 * @interface
5116 */
5117 interface SkillDisabledRequest {
5118 'type': 'AlexaSkillEvent.SkillDisabled';
5119 /**
5120 * Represents the unique identifier for the specific request.
5121 */
5122 'requestId': string;
5123 /**
5124 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5125 */
5126 'timestamp': string;
5127 /**
5128 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5129 */
5130 'locale'?: string;
5131 'eventCreationTime'?: string;
5132 'eventPublishingTime'?: string;
5133 }
5134}
5135export declare namespace events.skillevents {
5136 /**
5137 *
5138 * @interface
5139 */
5140 interface SkillEnabledRequest {
5141 'type': 'AlexaSkillEvent.SkillEnabled';
5142 /**
5143 * Represents the unique identifier for the specific request.
5144 */
5145 'requestId': string;
5146 /**
5147 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5148 */
5149 'timestamp': string;
5150 /**
5151 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5152 */
5153 'locale'?: string;
5154 'eventCreationTime'?: string;
5155 'eventPublishingTime'?: string;
5156 }
5157}
5158export declare namespace interfaces.alexa.advertisement {
5159 /**
5160 * The skill receives this event when the ad playback is finished. More details: https://tiny.amazon.com/tbfio2ru/wamazbinviewAlexTeamASKTInSk
5161 * @interface
5162 */
5163 interface AdCompleted {
5164 'type': 'Alexa.Advertisement.AdCompleted';
5165 /**
5166 * Represents the unique identifier for the specific request.
5167 */
5168 'requestId': string;
5169 /**
5170 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5171 */
5172 'timestamp': string;
5173 /**
5174 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5175 */
5176 'locale'?: string;
5177 /**
5178 * The current token representing the ad stream being played.
5179 */
5180 'token'?: string;
5181 }
5182}
5183export declare namespace interfaces.alexa.advertisement {
5184 /**
5185 * The skill receives this event when the ad cannot be displayed or played due to certain reasons. More details: https://tiny.amazon.com/16bnoj5db/wamazbinviewAlexTeamASKTInSk
5186 * @interface
5187 */
5188 interface AdNotRendered {
5189 'type': 'Alexa.Advertisement.AdNotRendered';
5190 /**
5191 * Represents the unique identifier for the specific request.
5192 */
5193 'requestId': string;
5194 /**
5195 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5196 */
5197 'timestamp': string;
5198 /**
5199 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5200 */
5201 'locale'?: string;
5202 /**
5203 * The object encapsulates information regarding the reasons why the ad is not being rendered.
5204 */
5205 'reason'?: interfaces.alexa.advertisement.Reason;
5206 }
5207}
5208export declare namespace interfaces.alexa.advertisement {
5209 /**
5210 *
5211 * @interface
5212 */
5213 interface InjectAds {
5214 'type': 'Alexa.Advertisement.InjectAds';
5215 /**
5216 * The optional expected previous token represents the content currently being played, and it is utilized to enqueue the advertisement after the ongoing audio content. More details: https://tiny.amazon.com/l9h6ejjr/wamazbinviewAlexTeamASKTInSk
5217 */
5218 'expectedPreviousToken'?: string;
5219 }
5220}
5221export declare namespace interfaces.alexa.advertisement {
5222 /**
5223 * This event is sent to the skill as a signal that it can enqueue the next audio content in the audio player. This allows the third-party skill to resume content playback after the advertisement.
5224 * @interface
5225 */
5226 interface ReadyToEnqueueAudio {
5227 'type': 'Alexa.Advertisement.ReadyToEnqueueAudio';
5228 /**
5229 * Represents the unique identifier for the specific request.
5230 */
5231 'requestId': string;
5232 /**
5233 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5234 */
5235 'timestamp': string;
5236 /**
5237 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5238 */
5239 'locale'?: string;
5240 /**
5241 * The token currently representing the ad stream being played can be used as the expectedPreviousToken in the AudioPlayer.Play directive. This allows the skill to enqueue the next content seamlessly after the ad stream.
5242 */
5243 'token'?: string;
5244 /**
5245 * The expectedPreviousToken passed in the InjectAds request, which can be utilized by a skill to maintain an ordered list and find the next content from the current content.
5246 */
5247 'previousToken'?: string;
5248 }
5249}
5250export declare namespace interfaces.alexa.datastore {
5251 /**
5252 * This event is sent by DSCS to forward ExecutionError from device or to inform about delivery error.
5253 * @interface
5254 */
5255 interface DataStoreError {
5256 'type': 'Alexa.DataStore.Error';
5257 /**
5258 * Represents the unique identifier for the specific request.
5259 */
5260 'requestId': string;
5261 /**
5262 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5263 */
5264 'timestamp': string;
5265 /**
5266 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5267 */
5268 'locale'?: string;
5269 'error': interfaces.alexa.datastore.CommandsError;
5270 }
5271}
5272export declare namespace interfaces.alexa.datastore {
5273 /**
5274 * Describes an execution error for unknown error from device DataStore.
5275 * @interface
5276 */
5277 interface DataStoreInternalError {
5278 'type': 'DATASTORE_INTERNAL_ERROR';
5279 'content': interfaces.alexa.datastore.ExecutionErrorContent;
5280 }
5281}
5282export declare namespace interfaces.alexa.datastore {
5283 /**
5284 * Describes a dispatch error when device is no longer available. Skill must stop pushing data to this device in the future.
5285 * @interface
5286 */
5287 interface DevicePermanantlyUnavailableError {
5288 'type': 'DEVICE_PERMANENTLY_UNAVAILABLE';
5289 'content': interfaces.alexa.datastore.DispatchErrorContent;
5290 }
5291}
5292export declare namespace interfaces.alexa.datastore {
5293 /**
5294 * Describes a dispatch error when device is not available.
5295 * @interface
5296 */
5297 interface DeviceUnavailableError {
5298 'type': 'DEVICE_UNAVAILABLE';
5299 'content': interfaces.alexa.datastore.DispatchErrorContent;
5300 }
5301}
5302export declare namespace interfaces.alexa.datastore {
5303 /**
5304 * Describes an execution error for exceeding storage limit.
5305 * @interface
5306 */
5307 interface StorageLimitExeceededError {
5308 'type': 'STORAGE_LIMIT_EXCEEDED';
5309 'content': interfaces.alexa.datastore.ExecutionErrorContent;
5310 }
5311}
5312export declare namespace interfaces.alexa.datastore.packagemanager {
5313 /**
5314 * This event is sent by device DataStore Package Manager to let the skill developer know that there was a problem installing/updating the package.
5315 * @interface
5316 */
5317 interface InstallationError {
5318 'type': 'Alexa.DataStore.PackageManager.InstallationError';
5319 /**
5320 * Represents the unique identifier for the specific request.
5321 */
5322 'requestId': string;
5323 /**
5324 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5325 */
5326 'timestamp': string;
5327 /**
5328 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5329 */
5330 'locale'?: string;
5331 /**
5332 * Unique package identifier for a client.
5333 */
5334 'packageId': string;
5335 /**
5336 * Current version of the package trying to be installed/updated on the device.
5337 */
5338 'version': string;
5339 'error': interfaces.alexa.datastore.packagemanager.PackageError;
5340 }
5341}
5342export declare namespace interfaces.alexa.datastore.packagemanager {
5343 /**
5344 * This event is request sent by device DataStore Package Manager asking the skill developer them to update the version of the package on device.
5345 * @interface
5346 */
5347 interface UpdateRequest {
5348 'type': 'Alexa.DataStore.PackageManager.UpdateRequest';
5349 /**
5350 * Represents the unique identifier for the specific request.
5351 */
5352 'requestId': string;
5353 /**
5354 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5355 */
5356 'timestamp': string;
5357 /**
5358 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5359 */
5360 'locale'?: string;
5361 /**
5362 * Unique package identifier for a client.
5363 */
5364 'packageId': string;
5365 /**
5366 * Current version of a package installed on the device.
5367 */
5368 'fromVersion': string;
5369 /**
5370 * Latest version of a package being installed on the device.
5371 */
5372 'toVersion': string;
5373 }
5374}
5375export declare namespace interfaces.alexa.datastore.packagemanager {
5376 /**
5377 * This event is sent by device DataStore Package Manager to the skill developer to let them know about the usages of the packages being installed on the device.
5378 * @interface
5379 */
5380 interface UsagesInstalled {
5381 'type': 'Alexa.DataStore.PackageManager.UsagesInstalled';
5382 /**
5383 * Represents the unique identifier for the specific request.
5384 */
5385 'requestId': string;
5386 /**
5387 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5388 */
5389 'timestamp': string;
5390 /**
5391 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5392 */
5393 'locale'?: string;
5394 'payload': interfaces.alexa.datastore.packagemanager.UsagesInstallRequest;
5395 }
5396}
5397export declare namespace interfaces.alexa.datastore.packagemanager {
5398 /**
5399 * This event is sent by device DataStore Package Manager to let the skill developer know about the usages of packages removed from the device.
5400 * @interface
5401 */
5402 interface UsagesRemoved {
5403 'type': 'Alexa.DataStore.PackageManager.UsagesRemoved';
5404 /**
5405 * Represents the unique identifier for the specific request.
5406 */
5407 'requestId': string;
5408 /**
5409 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5410 */
5411 'timestamp': string;
5412 /**
5413 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5414 */
5415 'locale'?: string;
5416 'payload': interfaces.alexa.datastore.packagemanager.UsagesRemovedRequest;
5417 }
5418}
5419export declare namespace interfaces.alexa.presentation {
5420 /**
5421 *
5422 * @interface
5423 */
5424 interface AplPresentationStateContext {
5425 'type': 'Alexa.Presentation.APL';
5426 'context'?: interfaces.alexa.presentation.apl.RenderedDocumentState;
5427 }
5428}
5429export declare namespace interfaces.alexa.presentation.apl {
5430 /**
5431 * Runs a fixed-duration animation sequence on one or more properties of a single component.
5432 * @interface
5433 */
5434 interface AnimateItemCommand {
5435 'type': 'AnimateItem';
5436 /**
5437 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5438 */
5439 'delay'?: number | string;
5440 /**
5441 * A user-provided description of this command.
5442 */
5443 'description'?: string;
5444 /**
5445 * If true, disable the Interaction Timer.
5446 */
5447 'screenLock'?: boolean;
5448 /**
5449 * Specify the sequencer that should execute this command.
5450 */
5451 'sequencer'?: string;
5452 /**
5453 * If false, the execution of the command is skipped. Defaults to true.
5454 */
5455 'when'?: boolean;
5456 /**
5457 * The ID of the animated component.
5458 */
5459 'componentId': string;
5460 /**
5461 * The duration of the animation (in milliseconds).
5462 */
5463 'duration': number | string;
5464 /**
5465 * The easing curve.
5466 */
5467 'easing'?: string;
5468 /**
5469 * Number of times to repeat.
5470 */
5471 'repeatCount'?: number | string;
5472 'repeatMode'?: interfaces.alexa.presentation.apl.AnimateItemRepeatMode;
5473 /**
5474 * An array of animated properties.
5475 */
5476 'value': Array<interfaces.alexa.presentation.apl.AnimatedProperty>;
5477 }
5478}
5479export declare namespace interfaces.alexa.presentation.apl {
5480 /**
5481 *
5482 * @interface
5483 */
5484 interface AnimatedOpacityProperty {
5485 'property': 'opacity';
5486 /**
5487 * The starting value of the property.
5488 */
5489 'from'?: number | string;
5490 /**
5491 * The ending value of the property.
5492 */
5493 'to': number | string;
5494 }
5495}
5496export declare namespace interfaces.alexa.presentation.apl {
5497 /**
5498 *
5499 * @interface
5500 */
5501 interface AnimatedTransformProperty {
5502 'property': 'transform';
5503 /**
5504 * The starting value of the property.
5505 */
5506 'from': Array<interfaces.alexa.presentation.apl.TransformProperty>;
5507 /**
5508 * The ending value of the property.
5509 */
5510 'to': Array<interfaces.alexa.presentation.apl.TransformProperty>;
5511 }
5512}
5513export declare namespace interfaces.alexa.presentation.apl {
5514 /**
5515 * Automatically progress through a series of pages displayed in a Pager component. The AutoPage command finishes after the last page has been displayed for the requested time period.
5516 * @interface
5517 */
5518 interface AutoPageCommand {
5519 'type': 'AutoPage';
5520 /**
5521 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5522 */
5523 'delay'?: number | string;
5524 /**
5525 * A user-provided description of this command.
5526 */
5527 'description'?: string;
5528 /**
5529 * If true, disable the Interaction Timer.
5530 */
5531 'screenLock'?: boolean;
5532 /**
5533 * Specify the sequencer that should execute this command.
5534 */
5535 'sequencer'?: string;
5536 /**
5537 * If false, the execution of the command is skipped. Defaults to true.
5538 */
5539 'when'?: boolean;
5540 /**
5541 * The id of the Pager component.
5542 */
5543 'componentId': string;
5544 /**
5545 * Number of pages to display. Defaults to all of them.
5546 */
5547 'count'?: number | string;
5548 /**
5549 * Time to wait between pages (in milliseconds). Defaults to 0.
5550 */
5551 'duration'?: number | string;
5552 }
5553}
5554export declare namespace interfaces.alexa.presentation.apl {
5555 /**
5556 * Removes focus from the component that is currently in focus.
5557 * @interface
5558 */
5559 interface ClearFocusCommand {
5560 'type': 'ClearFocus';
5561 /**
5562 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5563 */
5564 'delay'?: number | string;
5565 /**
5566 * A user-provided description of this command.
5567 */
5568 'description'?: string;
5569 /**
5570 * If true, disable the Interaction Timer.
5571 */
5572 'screenLock'?: boolean;
5573 /**
5574 * Specify the sequencer that should execute this command.
5575 */
5576 'sequencer'?: string;
5577 /**
5578 * If false, the execution of the command is skipped. Defaults to true.
5579 */
5580 'when'?: boolean;
5581 }
5582}
5583export declare namespace interfaces.alexa.presentation.apl {
5584 /**
5585 * Control a media player to play, pause, change tracks, or perform some other common action.
5586 * @interface
5587 */
5588 interface ControlMediaCommand {
5589 'type': 'ControlMedia';
5590 /**
5591 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5592 */
5593 'delay'?: number | string;
5594 /**
5595 * A user-provided description of this command.
5596 */
5597 'description'?: string;
5598 /**
5599 * If true, disable the Interaction Timer.
5600 */
5601 'screenLock'?: boolean;
5602 /**
5603 * Specify the sequencer that should execute this command.
5604 */
5605 'sequencer'?: string;
5606 /**
5607 * If false, the execution of the command is skipped. Defaults to true.
5608 */
5609 'when'?: boolean;
5610 /**
5611 * The command to issue on the media player
5612 */
5613 'command': interfaces.alexa.presentation.apl.MediaCommandType;
5614 /**
5615 * The name of the media playing component
5616 */
5617 'componentId'?: string;
5618 /**
5619 * Optional data value
5620 */
5621 'value'?: number | string;
5622 }
5623}
5624export declare namespace interfaces.alexa.presentation.apl {
5625 /**
5626 * Alexa.Presentation.APL.ExecuteCommands directive used to send APL commands to a device.
5627 * @interface
5628 */
5629 interface ExecuteCommandsDirective {
5630 'type': 'Alexa.Presentation.APL.ExecuteCommands';
5631 /**
5632 * List of Command instances
5633 */
5634 'commands': Array<interfaces.alexa.presentation.apl.Command>;
5635 /**
5636 * A skill defined token, unique for each presentation. Must match the token provided by the skill in the RenderDocument directive used to render the original APL document.
5637 */
5638 'token': string;
5639 }
5640}
5641export declare namespace interfaces.alexa.presentation.apl {
5642 /**
5643 * The finish command closes the current APL document and exits.
5644 * @interface
5645 */
5646 interface FinishCommand {
5647 'type': 'Finish';
5648 /**
5649 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5650 */
5651 'delay'?: number | string;
5652 /**
5653 * A user-provided description of this command.
5654 */
5655 'description'?: string;
5656 /**
5657 * If true, disable the Interaction Timer.
5658 */
5659 'screenLock'?: boolean;
5660 /**
5661 * Specify the sequencer that should execute this command.
5662 */
5663 'sequencer'?: string;
5664 /**
5665 * If false, the execution of the command is skipped. Defaults to true.
5666 */
5667 'when'?: boolean;
5668 }
5669}
5670export declare namespace interfaces.alexa.presentation.apl {
5671 /**
5672 * GoBack command POJO for the backstack APL extension.
5673 * @interface
5674 */
5675 interface GoBackCommand {
5676 'type': 'GoBack';
5677 /**
5678 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5679 */
5680 'delay'?: number | string;
5681 /**
5682 * A user-provided description of this command.
5683 */
5684 'description'?: string;
5685 /**
5686 * If true, disable the Interaction Timer.
5687 */
5688 'screenLock'?: boolean;
5689 /**
5690 * Specify the sequencer that should execute this command.
5691 */
5692 'sequencer'?: string;
5693 /**
5694 * If false, the execution of the command is skipped. Defaults to true.
5695 */
5696 'when'?: boolean;
5697 'backType': interfaces.alexa.presentation.apl.BackType;
5698 /**
5699 * The value of go back command.
5700 */
5701 'backValue': string;
5702 }
5703}
5704export declare namespace interfaces.alexa.presentation.apl {
5705 /**
5706 * HideOverlay Command used by television shopping skill.
5707 * @interface
5708 */
5709 interface HideOverlayCommand {
5710 'type': 'HideOverlay';
5711 /**
5712 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5713 */
5714 'delay'?: number | string;
5715 /**
5716 * A user-provided description of this command.
5717 */
5718 'description'?: string;
5719 /**
5720 * If true, disable the Interaction Timer.
5721 */
5722 'screenLock'?: boolean;
5723 /**
5724 * Specify the sequencer that should execute this command.
5725 */
5726 'sequencer'?: string;
5727 /**
5728 * If false, the execution of the command is skipped. Defaults to true.
5729 */
5730 'when'?: boolean;
5731 /**
5732 * The id of overlay Layout.
5733 */
5734 'overlayLayoutId': string;
5735 /**
5736 * The id of underlying Layout.
5737 */
5738 'underlyingLayoutId'?: string;
5739 /**
5740 * The overlay width.
5741 */
5742 'overlayWidth'?: string;
5743 /**
5744 * The duration of HideOverlay Command.
5745 */
5746 'duration'?: number;
5747 }
5748}
5749export declare namespace interfaces.alexa.presentation.apl {
5750 /**
5751 * The idle command does nothing. It may be a placeholder or used to insert a calculated delay in a longer series of commands.
5752 * @interface
5753 */
5754 interface IdleCommand {
5755 'type': 'Idle';
5756 /**
5757 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5758 */
5759 'delay'?: number | string;
5760 /**
5761 * A user-provided description of this command.
5762 */
5763 'description'?: string;
5764 /**
5765 * If true, disable the Interaction Timer.
5766 */
5767 'screenLock'?: boolean;
5768 /**
5769 * Specify the sequencer that should execute this command.
5770 */
5771 'sequencer'?: string;
5772 /**
5773 * If false, the execution of the command is skipped. Defaults to true.
5774 */
5775 'when'?: boolean;
5776 }
5777}
5778export declare namespace interfaces.alexa.presentation.apl {
5779 /**
5780 * Reports an error with list functionality.
5781 * @interface
5782 */
5783 interface ListRuntimeError {
5784 'type': 'LIST_ERROR';
5785 /**
5786 * A human-readable description of the error.
5787 */
5788 'message': string;
5789 /**
5790 * The token as specified in the presentation's RenderDocument directive.
5791 */
5792 'token'?: string;
5793 'reason': interfaces.alexa.presentation.apl.ListRuntimeErrorReason;
5794 /**
5795 * The identifier of the list in which the error occurred.
5796 */
5797 'listId': string;
5798 /**
5799 * The listVersion in which the error occurred.
5800 */
5801 'listVersion'?: number;
5802 /**
5803 * The index of the operation which caused the error (if known)
5804 */
5805 'operationIndex'?: number;
5806 }
5807}
5808export declare namespace interfaces.alexa.presentation.apl {
5809 /**
5810 * The LoadIndexListData event is sent to the skill to retrieve additional list items.
5811 * @interface
5812 */
5813 interface LoadIndexListDataEvent {
5814 'type': 'Alexa.Presentation.APL.LoadIndexListData';
5815 /**
5816 * Represents the unique identifier for the specific request.
5817 */
5818 'requestId': string;
5819 /**
5820 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5821 */
5822 'timestamp': string;
5823 /**
5824 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5825 */
5826 'locale'?: string;
5827 /**
5828 * The token as specified in the presentation's RenderDocument directive.
5829 */
5830 'token': string;
5831 /**
5832 * An identifier generated by a device that is used to correlate requests with their corresponding response directives.
5833 */
5834 'correlationToken': string;
5835 /**
5836 * The identifier of the list whose items to fetch.
5837 */
5838 'listId': string;
5839 /**
5840 * The lowest index of the items to fetch (inclusive)
5841 */
5842 'startIndex': number;
5843 /**
5844 * The number of items to fetch. Examples: startIndex = 10, count = 2: Skill is expected to return items at indexes 10 and 11. startIndex = -2, count = 5: Skill is expected to return items at indexes -2, -1, 0, 1 and 2
5845 */
5846 'count': number;
5847 }
5848}
5849export declare namespace interfaces.alexa.presentation.apl {
5850 /**
5851 * The LoadTokenListData event is sent to the skill to retrieve additional list items.
5852 * @interface
5853 */
5854 interface LoadTokenListDataEvent {
5855 'type': 'Alexa.Presentation.APL.LoadTokenListData';
5856 /**
5857 * Represents the unique identifier for the specific request.
5858 */
5859 'requestId': string;
5860 /**
5861 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
5862 */
5863 'timestamp': string;
5864 /**
5865 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
5866 */
5867 'locale'?: string;
5868 /**
5869 * The token as specified in the presentation's RenderDocument directive.
5870 */
5871 'token': string;
5872 /**
5873 * An identifier generated by a device that is used to correlate requests with their corresponding response directives.
5874 */
5875 'correlationToken': string;
5876 /**
5877 * The identifier of the list whose items to fetch.
5878 */
5879 'listId': string;
5880 /**
5881 * Opaque token of the array of items to fetch. The skill is expected to be able to identify whether the token represents a forward or backward scroll direction.
5882 */
5883 'pageToken': string;
5884 }
5885}
5886export declare namespace interfaces.alexa.presentation.apl {
5887 /**
5888 *
5889 * @interface
5890 */
5891 interface MoveTransformProperty {
5892 /**
5893 * Distance to translate the object to the right.
5894 */
5895 'translateX'?: string;
5896 /**
5897 * Distance to translate the object down.
5898 */
5899 'translateY'?: string;
5900 }
5901}
5902export declare namespace interfaces.alexa.presentation.apl {
5903 /**
5904 * Opens a url with web browser or other application on the device. The APL author is responsible for providing a suitable URL that works on the current device.
5905 * @interface
5906 */
5907 interface OpenUrlCommand {
5908 'type': 'OpenURL';
5909 /**
5910 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5911 */
5912 'delay'?: number | string;
5913 /**
5914 * A user-provided description of this command.
5915 */
5916 'description'?: string;
5917 /**
5918 * If true, disable the Interaction Timer.
5919 */
5920 'screenLock'?: boolean;
5921 /**
5922 * Specify the sequencer that should execute this command.
5923 */
5924 'sequencer'?: string;
5925 /**
5926 * If false, the execution of the command is skipped. Defaults to true.
5927 */
5928 'when'?: boolean;
5929 /**
5930 * The URL to open
5931 */
5932 'source': string;
5933 /**
5934 * Commands to execute if the URL fails to open
5935 */
5936 'onFail'?: Array<interfaces.alexa.presentation.apl.Command>;
5937 }
5938}
5939export declare namespace interfaces.alexa.presentation.apl {
5940 /**
5941 * Execute a series of commands in parallel. The parallel command starts executing all child command simultaneously. The parallel command is considered finished when all of its child commands have finished. When the parallel command is terminated early, all currently executing commands are terminated.
5942 * @interface
5943 */
5944 interface ParallelCommand {
5945 'type': 'Parallel';
5946 /**
5947 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5948 */
5949 'delay'?: number | string;
5950 /**
5951 * A user-provided description of this command.
5952 */
5953 'description'?: string;
5954 /**
5955 * If true, disable the Interaction Timer.
5956 */
5957 'screenLock'?: boolean;
5958 /**
5959 * Specify the sequencer that should execute this command.
5960 */
5961 'sequencer'?: string;
5962 /**
5963 * If false, the execution of the command is skipped. Defaults to true.
5964 */
5965 'when'?: boolean;
5966 /**
5967 * An un-ordered array of commands to execute in parallel. Once all commands have finished executing the parallel command finishes. Please note that the delay of parallel command and the delay of each command are additive.
5968 */
5969 'commands': Array<interfaces.alexa.presentation.apl.Command>;
5970 }
5971}
5972export declare namespace interfaces.alexa.presentation.apl {
5973 /**
5974 * Plays media on a media player (currently only a Video player; audio may be added in the future). The media may be on the background audio track or may be sequenced with speak directives).
5975 * @interface
5976 */
5977 interface PlayMediaCommand {
5978 'type': 'PlayMedia';
5979 /**
5980 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
5981 */
5982 'delay'?: number | string;
5983 /**
5984 * A user-provided description of this command.
5985 */
5986 'description'?: string;
5987 /**
5988 * If true, disable the Interaction Timer.
5989 */
5990 'screenLock'?: boolean;
5991 /**
5992 * Specify the sequencer that should execute this command.
5993 */
5994 'sequencer'?: string;
5995 /**
5996 * If false, the execution of the command is skipped. Defaults to true.
5997 */
5998 'when'?: boolean;
5999 /**
6000 * The command to issue on the media player
6001 */
6002 'audioTrack'?: interfaces.alexa.presentation.apl.AudioTrack;
6003 /**
6004 * The name of the media playing component
6005 */
6006 'componentId'?: string;
6007 /**
6008 * The media source
6009 */
6010 'source': Array<interfaces.alexa.presentation.apl.VideoSource>;
6011 }
6012}
6013export declare namespace interfaces.alexa.presentation.apl {
6014 /**
6015 * The reinflate command reinflates the current document with updated configuration properties.
6016 * @interface
6017 */
6018 interface ReinflateCommand {
6019 'type': 'Reinflate';
6020 /**
6021 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6022 */
6023 'delay'?: number | string;
6024 /**
6025 * A user-provided description of this command.
6026 */
6027 'description'?: string;
6028 /**
6029 * If true, disable the Interaction Timer.
6030 */
6031 'screenLock'?: boolean;
6032 /**
6033 * Specify the sequencer that should execute this command.
6034 */
6035 'sequencer'?: string;
6036 /**
6037 * If false, the execution of the command is skipped. Defaults to true.
6038 */
6039 'when'?: boolean;
6040 }
6041}
6042export declare namespace interfaces.alexa.presentation.apl {
6043 /**
6044 *
6045 * @interface
6046 */
6047 interface RenderDocumentDirective {
6048 'type': 'Alexa.Presentation.APL.RenderDocument';
6049 /**
6050 * A unique identifier for the presentation.
6051 */
6052 'token'?: string;
6053 /**
6054 * Depending on the document type, it represents either an entire APL document or a reference Link to the document. In a Link object, the value of the 'src' should follow a URI format defined like 'doc://alexa/apl/documents/<document_id>'. The 'document_id' is a reference to the APL document that the developer stores through APL Authoring Tool.
6055 */
6056 'document'?: {
6057 [key: string]: any;
6058 };
6059 /**
6060 * Data sources to bind to the document when rendering.
6061 */
6062 'datasources'?: {
6063 [key: string]: any;
6064 };
6065 /**
6066 * An object containing named documents or links. These documents can be referenced by the “template” parameter in the transformer.
6067 */
6068 'sources'?: {
6069 [key: string]: any;
6070 };
6071 /**
6072 * A list of packages including layouts, styles, and images etc.
6073 */
6074 'packages'?: Array<any>;
6075 }
6076}
6077export declare namespace interfaces.alexa.presentation.apl {
6078 /**
6079 *
6080 * @interface
6081 */
6082 interface RotateTransformProperty {
6083 /**
6084 * Rotation angle, in degrees. Positive angles rotate in the clockwise direction.
6085 */
6086 'rotate'?: number | string;
6087 }
6088}
6089export declare namespace interfaces.alexa.presentation.apl {
6090 /**
6091 * Notifies the skill of any errors in APL functionality.
6092 * @interface
6093 */
6094 interface RuntimeErrorEvent {
6095 'type': 'Alexa.Presentation.APL.RuntimeError';
6096 /**
6097 * Represents the unique identifier for the specific request.
6098 */
6099 'requestId': string;
6100 /**
6101 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
6102 */
6103 'timestamp': string;
6104 /**
6105 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
6106 */
6107 'locale'?: string;
6108 /**
6109 * The unique identifier of the presentation in which the error occurred.
6110 */
6111 'token': string;
6112 /**
6113 * An array of errors encountered while running the APL presentation.
6114 */
6115 'errors': Array<interfaces.alexa.presentation.apl.RuntimeError>;
6116 }
6117}
6118export declare namespace interfaces.alexa.presentation.apl {
6119 /**
6120 *
6121 * @interface
6122 */
6123 interface ScaleTransformProperty {
6124 /**
6125 * Uniform scaling in both X and Y.
6126 */
6127 'scale'?: number | string;
6128 /**
6129 * Scaling in the X direction (overrides “scale” if in same group).
6130 */
6131 'scaleX'?: number | string;
6132 /**
6133 * Scaling in the Y direction (overrides “scale” if in same group).
6134 */
6135 'scaleY'?: number | string;
6136 }
6137}
6138export declare namespace interfaces.alexa.presentation.apl {
6139 /**
6140 * Scroll a ScrollView or Sequence forward or backward by a number of pages. The Scroll command has the following properties in addition to the regular command properties.
6141 * @interface
6142 */
6143 interface ScrollCommand {
6144 'type': 'Scroll';
6145 /**
6146 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6147 */
6148 'delay'?: number | string;
6149 /**
6150 * A user-provided description of this command.
6151 */
6152 'description'?: string;
6153 /**
6154 * If true, disable the Interaction Timer.
6155 */
6156 'screenLock'?: boolean;
6157 /**
6158 * Specify the sequencer that should execute this command.
6159 */
6160 'sequencer'?: string;
6161 /**
6162 * If false, the execution of the command is skipped. Defaults to true.
6163 */
6164 'when'?: boolean;
6165 /**
6166 * The number of pages to scroll. Defaults to 1.
6167 */
6168 'distance'?: number | string;
6169 /**
6170 * The id of the component.
6171 */
6172 'componentId': string;
6173 }
6174}
6175export declare namespace interfaces.alexa.presentation.apl {
6176 /**
6177 * Scroll forward or backward through a ScrollView or Sequence to ensure that a particular component is in view.
6178 * @interface
6179 */
6180 interface ScrollToComponentCommand {
6181 'type': 'ScrollToComponent';
6182 /**
6183 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6184 */
6185 'delay'?: number | string;
6186 /**
6187 * A user-provided description of this command.
6188 */
6189 'description'?: string;
6190 /**
6191 * If true, disable the Interaction Timer.
6192 */
6193 'screenLock'?: boolean;
6194 /**
6195 * Specify the sequencer that should execute this command.
6196 */
6197 'sequencer'?: string;
6198 /**
6199 * If false, the execution of the command is skipped. Defaults to true.
6200 */
6201 'when'?: boolean;
6202 'align'?: interfaces.alexa.presentation.apl.Align;
6203 /**
6204 * The id of the component. If omitted, the component issuing the ScrollToComponent command is used.
6205 */
6206 'componentId'?: string;
6207 }
6208}
6209export declare namespace interfaces.alexa.presentation.apl {
6210 /**
6211 * Scroll forward or backward through a ScrollView or Sequence to ensure that a particular child component is in view.
6212 * @interface
6213 */
6214 interface ScrollToIndexCommand {
6215 'type': 'ScrollToIndex';
6216 /**
6217 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6218 */
6219 'delay'?: number | string;
6220 /**
6221 * A user-provided description of this command.
6222 */
6223 'description'?: string;
6224 /**
6225 * If true, disable the Interaction Timer.
6226 */
6227 'screenLock'?: boolean;
6228 /**
6229 * Specify the sequencer that should execute this command.
6230 */
6231 'sequencer'?: string;
6232 /**
6233 * If false, the execution of the command is skipped. Defaults to true.
6234 */
6235 'when'?: boolean;
6236 'align'?: interfaces.alexa.presentation.apl.Align;
6237 /**
6238 * The id of the component.
6239 */
6240 'componentId': string;
6241 /**
6242 * The 0-based index of the child to display.
6243 */
6244 'index': number | string;
6245 }
6246}
6247export declare namespace interfaces.alexa.presentation.apl {
6248 /**
6249 * Select a single command from an array of commands and data.
6250 * @interface
6251 */
6252 interface SelectCommand {
6253 'type': 'Select';
6254 /**
6255 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6256 */
6257 'delay'?: number | string;
6258 /**
6259 * A user-provided description of this command.
6260 */
6261 'description'?: string;
6262 /**
6263 * If true, disable the Interaction Timer.
6264 */
6265 'screenLock'?: boolean;
6266 /**
6267 * Specify the sequencer that should execute this command.
6268 */
6269 'sequencer'?: string;
6270 /**
6271 * If false, the execution of the command is skipped. Defaults to true.
6272 */
6273 'when'?: boolean;
6274 /**
6275 * An ordered list of commands to select from.
6276 */
6277 'commands': Array<interfaces.alexa.presentation.apl.Command>;
6278 /**
6279 * A list of data to map against the commands.
6280 */
6281 'data'?: Array<any>;
6282 /**
6283 * Commands to execute if nothing else runs.
6284 */
6285 'otherwise'?: Array<interfaces.alexa.presentation.apl.Command>;
6286 }
6287}
6288export declare namespace interfaces.alexa.presentation.apl {
6289 /**
6290 * The SendEvent command allows the APL author to generate and send an event to Alexa.
6291 * @interface
6292 */
6293 interface SendEventCommand {
6294 'type': 'SendEvent';
6295 /**
6296 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6297 */
6298 'delay'?: number | string;
6299 /**
6300 * A user-provided description of this command.
6301 */
6302 'description'?: string;
6303 /**
6304 * If true, disable the Interaction Timer.
6305 */
6306 'screenLock'?: boolean;
6307 /**
6308 * Specify the sequencer that should execute this command.
6309 */
6310 'sequencer'?: string;
6311 /**
6312 * If false, the execution of the command is skipped. Defaults to true.
6313 */
6314 'when'?: boolean;
6315 /**
6316 * An array of argument data to pass to Alexa.
6317 */
6318 'arguments'?: Array<string>;
6319 /**
6320 * An array of components to extract value data from and provide to Alexa.
6321 */
6322 'components'?: Array<string>;
6323 }
6324}
6325export declare namespace interfaces.alexa.presentation.apl {
6326 /**
6327 * Returned in response to a LoadIndexListData event, containing the requested items and metadata for further interaction.
6328 * @interface
6329 */
6330 interface SendIndexListDataDirective {
6331 'type': 'Alexa.Presentation.APL.SendIndexListData';
6332 /**
6333 * The correlation token supplied in the LoadTokenListData event. This parameter is mandatory if the skill is responding to a LoadIndexListData request, the skill response will be rejected if the expected correlationToken is not specified.
6334 */
6335 'correlationToken'?: string;
6336 /**
6337 * The identifier of the list whose items are contained in this response.
6338 */
6339 'listId': string;
6340 /**
6341 * The new version of the list after loading the items supplied in this directive. List versions increase sequentially, implicitly starting at 0 for the definition specified in the presentation's RenderDocument directive.
6342 */
6343 'listVersion'?: number;
6344 /**
6345 * Index of the first element in the items array.
6346 */
6347 'startIndex': number;
6348 /**
6349 * The index of the 1st item in the skill-managed array. When populated, this value replaces any value that was specified in a previous interaction. Continued absence of this property indicates that the minimum index is not yet known and further backwards scrolling is possible. If this is equal to the index of the 1st item returned then no further backwards scrolling is possible.
6350 */
6351 'minimumInclusiveIndex'?: number;
6352 /**
6353 * The last valid index of the skill-managed array plus one, i.e. exclusive value. When populated, this value replaces any value that was specified in a previous interaction. Continued absence of this property indicates that the maximum index is not yet known and further forwards scrolling is possible. If this is one more than the index of the last item returned then no further forwards scrolling is possible.
6354 */
6355 'maximumExclusiveIndex'?: number;
6356 /**
6357 * Array of objects to be added to the device cache.
6358 */
6359 'items'?: Array<any>;
6360 }
6361}
6362export declare namespace interfaces.alexa.presentation.apl {
6363 /**
6364 * Returned in response to a LoadTokenListData event, containing the requested items and metadata for further interaction.
6365 * @interface
6366 */
6367 interface SendTokenListDataDirective {
6368 'type': 'Alexa.Presentation.APL.SendTokenListData';
6369 /**
6370 * The correlation token supplied in the LoadTokenListData event. This parameter is mandatory if the skill is responding to a LoadTokenListData request, the skill response will be rejected if the expected correlationToken is not specified.
6371 */
6372 'correlationToken'?: string;
6373 /**
6374 * The identifier of the list whose items are contained in this response.
6375 */
6376 'listId': string;
6377 /**
6378 * Opaque token for the array of items which are contained in this response. Ignored by the system if correlationToken is specified, but considered less cognitive overhead to have the developer always include & assists platform debugging.
6379 */
6380 'pageToken': string;
6381 /**
6382 * Opaque token to retrieve the next page of list items data. Absence of this property indicates that the last item in the list has been reached in the scroll direction.
6383 */
6384 'nextPageToken'?: string;
6385 /**
6386 * Array of objects to be added to the device cache.
6387 */
6388 'items'?: Array<any>;
6389 }
6390}
6391export declare namespace interfaces.alexa.presentation.apl {
6392 /**
6393 * A sequential command executes a series of commands in order. The sequential command executes the command list in order, waiting for the previous command to finish before executing the next. The sequential command is finished when all of its child commands have finished. When the Sequential command is terminated early, the currently executing command is terminated and no further commands are executed.
6394 * @interface
6395 */
6396 interface SequentialCommand {
6397 'type': 'Sequential';
6398 /**
6399 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6400 */
6401 'delay'?: number | string;
6402 /**
6403 * A user-provided description of this command.
6404 */
6405 'description'?: string;
6406 /**
6407 * If true, disable the Interaction Timer.
6408 */
6409 'screenLock'?: boolean;
6410 /**
6411 * Specify the sequencer that should execute this command.
6412 */
6413 'sequencer'?: string;
6414 /**
6415 * If false, the execution of the command is skipped. Defaults to true.
6416 */
6417 'when'?: boolean;
6418 /**
6419 * An ordered list of commands to execute if this sequence is prematurely terminated.
6420 */
6421 'catch'?: Array<interfaces.alexa.presentation.apl.Command>;
6422 /**
6423 * An array of commands to execute. The commands execute in order; each command must finish before the next can begin. Please note that the delay of sequential command and the delay of the first command in the sequence are additive.
6424 */
6425 'commands': Array<interfaces.alexa.presentation.apl.Command>;
6426 /**
6427 * An ordered list of commands to execute after the normal commands and the catch commands.
6428 */
6429 'finally'?: Array<interfaces.alexa.presentation.apl.Command>;
6430 /**
6431 * The number of times to repeat this series of commands. Defaults to 0. Negative values will be ignored. Note that the delay assigned to overall sequential command only applies the first time. For example, in the sample sequential command below the first SendEvent fires at 3000 milliseconds, the second at 5000, the first SendEvent fires again at 7000 milliseconds, and so forth. {\"type\": \"Sequential\",\"delay\": 1000,\"repeatCount\": 2,\"commands\": [{ \"type\": \"SendEvent\",\"delay\": 2000},{\"type\": \"SendEvent\",\"delay\": 2000}]}
6432 */
6433 'repeatCount'?: number | string;
6434 }
6435}
6436export declare namespace interfaces.alexa.presentation.apl {
6437 /**
6438 * Changes the actionable component that is in focus. Only one component may have focus at a time.
6439 * @interface
6440 */
6441 interface SetFocusCommand {
6442 'type': 'SetFocus';
6443 /**
6444 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6445 */
6446 'delay'?: number | string;
6447 /**
6448 * A user-provided description of this command.
6449 */
6450 'description'?: string;
6451 /**
6452 * If true, disable the Interaction Timer.
6453 */
6454 'screenLock'?: boolean;
6455 /**
6456 * Specify the sequencer that should execute this command.
6457 */
6458 'sequencer'?: string;
6459 /**
6460 * If false, the execution of the command is skipped. Defaults to true.
6461 */
6462 'when'?: boolean;
6463 /**
6464 * The ID of the component to set focus on.
6465 */
6466 'componentId': string;
6467 }
6468}
6469export declare namespace interfaces.alexa.presentation.apl {
6470 /**
6471 * Change the page displayed in a Pager component. The SetPage command finishes when the item is fully in view.
6472 * @interface
6473 */
6474 interface SetPageCommand {
6475 'type': 'SetPage';
6476 /**
6477 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6478 */
6479 'delay'?: number | string;
6480 /**
6481 * A user-provided description of this command.
6482 */
6483 'description'?: string;
6484 /**
6485 * If true, disable the Interaction Timer.
6486 */
6487 'screenLock'?: boolean;
6488 /**
6489 * Specify the sequencer that should execute this command.
6490 */
6491 'sequencer'?: string;
6492 /**
6493 * If false, the execution of the command is skipped. Defaults to true.
6494 */
6495 'when'?: boolean;
6496 /**
6497 * The id of the Pager component.
6498 */
6499 'componentId': string;
6500 'position'?: interfaces.alexa.presentation.apl.Position;
6501 /**
6502 * The distance to move. May be an absolute value or a relative value.
6503 */
6504 'value': number | string;
6505 }
6506}
6507export declare namespace interfaces.alexa.presentation.apl {
6508 /**
6509 * The SetState command changes one of the component’s state settings. The SetState command can be used to change the checked, disabled, and focused states. The karaoke and pressed states may not be directly set; use the Select command or SpeakItem commands to change those states. Also, note that the focused state may only be set - it can’t be cleared.
6510 * @interface
6511 */
6512 interface SetStateCommand {
6513 'type': 'SetState';
6514 /**
6515 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6516 */
6517 'delay'?: number | string;
6518 /**
6519 * A user-provided description of this command.
6520 */
6521 'description'?: string;
6522 /**
6523 * If true, disable the Interaction Timer.
6524 */
6525 'screenLock'?: boolean;
6526 /**
6527 * Specify the sequencer that should execute this command.
6528 */
6529 'sequencer'?: string;
6530 /**
6531 * If false, the execution of the command is skipped. Defaults to true.
6532 */
6533 'when'?: boolean;
6534 /**
6535 * The id of the component whose value should be set.
6536 */
6537 'componentId'?: string;
6538 /**
6539 * The name of the state to set. Must be one of “checked”, “disabled”, and “focused”.
6540 */
6541 'state': interfaces.alexa.presentation.apl.ComponentState;
6542 /**
6543 * The value to set on the property
6544 */
6545 'value': boolean | string;
6546 }
6547}
6548export declare namespace interfaces.alexa.presentation.apl {
6549 /**
6550 * Change a dynamic property of a component without redrawing the screen.
6551 * @interface
6552 */
6553 interface SetValueCommand {
6554 'type': 'SetValue';
6555 /**
6556 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6557 */
6558 'delay'?: number | string;
6559 /**
6560 * A user-provided description of this command.
6561 */
6562 'description'?: string;
6563 /**
6564 * If true, disable the Interaction Timer.
6565 */
6566 'screenLock'?: boolean;
6567 /**
6568 * Specify the sequencer that should execute this command.
6569 */
6570 'sequencer'?: string;
6571 /**
6572 * If false, the execution of the command is skipped. Defaults to true.
6573 */
6574 'when'?: boolean;
6575 /**
6576 * The id of the component whose value to set.
6577 */
6578 'componentId'?: string;
6579 /**
6580 * The name of the property to set.
6581 */
6582 'property': string;
6583 /**
6584 * The property value to set.
6585 */
6586 'value': string;
6587 }
6588}
6589export declare namespace interfaces.alexa.presentation.apl {
6590 /**
6591 * ShowOverlay Command used by television shopping skill.
6592 * @interface
6593 */
6594 interface ShowOverlayCommand {
6595 'type': 'ShowOverlay';
6596 /**
6597 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6598 */
6599 'delay'?: number | string;
6600 /**
6601 * A user-provided description of this command.
6602 */
6603 'description'?: string;
6604 /**
6605 * If true, disable the Interaction Timer.
6606 */
6607 'screenLock'?: boolean;
6608 /**
6609 * Specify the sequencer that should execute this command.
6610 */
6611 'sequencer'?: string;
6612 /**
6613 * If false, the execution of the command is skipped. Defaults to true.
6614 */
6615 'when'?: boolean;
6616 /**
6617 * The id of overlay Layout.
6618 */
6619 'overlayLayoutId': string;
6620 /**
6621 * The id of underlying Layout.
6622 */
6623 'underlyingLayoutId'?: string;
6624 /**
6625 * The overlay width.
6626 */
6627 'overlayWidth'?: string;
6628 /**
6629 * The duration of ShowOverlay Command.
6630 */
6631 'duration'?: number;
6632 }
6633}
6634export declare namespace interfaces.alexa.presentation.apl {
6635 /**
6636 *
6637 * @interface
6638 */
6639 interface SkewTransformProperty {
6640 /**
6641 * Skew angle for the X-axis, in degrees. X-axis lines remain horizontal.
6642 */
6643 'skewX'?: number | string;
6644 /**
6645 * Skew angle for the Y-axis, in degrees. Y-axis lines remain vertical.
6646 */
6647 'skewY'?: number | string;
6648 }
6649}
6650export declare namespace interfaces.alexa.presentation.apl {
6651 /**
6652 * Reads the contents of a single item on the screen. By default the item will be scrolled into view if it is not currently visible.
6653 * @interface
6654 */
6655 interface SpeakItemCommand {
6656 'type': 'SpeakItem';
6657 /**
6658 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6659 */
6660 'delay'?: number | string;
6661 /**
6662 * A user-provided description of this command.
6663 */
6664 'description'?: string;
6665 /**
6666 * If true, disable the Interaction Timer.
6667 */
6668 'screenLock'?: boolean;
6669 /**
6670 * Specify the sequencer that should execute this command.
6671 */
6672 'sequencer'?: string;
6673 /**
6674 * If false, the execution of the command is skipped. Defaults to true.
6675 */
6676 'when'?: boolean;
6677 'align'?: interfaces.alexa.presentation.apl.Align;
6678 /**
6679 * The id of the component to speak.
6680 */
6681 'componentId': string;
6682 'highlightMode'?: interfaces.alexa.presentation.apl.HighlightMode;
6683 /**
6684 * The minimum number of milliseconds that an item should be highlighted for. Defaults to 0.
6685 */
6686 'minimumDwellTime'?: number | string;
6687 }
6688}
6689export declare namespace interfaces.alexa.presentation.apl {
6690 /**
6691 * Read the contents of a range of items inside a common container. Each item will scroll into view before speech. Each item should have a speech property, but it is not required.
6692 * @interface
6693 */
6694 interface SpeakListCommand {
6695 'type': 'SpeakList';
6696 /**
6697 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6698 */
6699 'delay'?: number | string;
6700 /**
6701 * A user-provided description of this command.
6702 */
6703 'description'?: string;
6704 /**
6705 * If true, disable the Interaction Timer.
6706 */
6707 'screenLock'?: boolean;
6708 /**
6709 * Specify the sequencer that should execute this command.
6710 */
6711 'sequencer'?: string;
6712 /**
6713 * If false, the execution of the command is skipped. Defaults to true.
6714 */
6715 'when'?: boolean;
6716 'align'?: interfaces.alexa.presentation.apl.Align;
6717 /**
6718 * The id of the component to read.
6719 */
6720 'componentId': string;
6721 /**
6722 * The number of items to speak
6723 */
6724 'count': number | string;
6725 /**
6726 * The minimum number of milliseconds that an item will be highlighted for. Defaults to 0.
6727 */
6728 'minimumDwellTime'?: number | string;
6729 /**
6730 * The 0-based index of the first item to speak
6731 */
6732 'start': number | string;
6733 }
6734}
6735export declare namespace interfaces.alexa.presentation.apl {
6736 /**
6737 * Updates the content of an dynamicIndexList datasource which has been previously communicated to an Alexa device.
6738 * @interface
6739 */
6740 interface UpdateIndexListDataDirective {
6741 'type': 'Alexa.Presentation.APL.UpdateIndexListData';
6742 /**
6743 * The unique identifier for the presentation containing the dynamicIndexList.
6744 */
6745 'token': string;
6746 /**
6747 * The identifier of the dynamicIndexList to update.
6748 */
6749 'listId': string;
6750 /**
6751 * The new version of the list after applying the updates specified in this directive. List versions increase sequentially, implicitly starting at 0 for the definition specified in the presentation's RenderDocument directive.
6752 */
6753 'listVersion': number;
6754 /**
6755 * An array of changes which are to be applied to the items in the dynamicIndexList.
6756 */
6757 'operations': Array<interfaces.alexa.presentation.apl.listoperations.Operation>;
6758 }
6759}
6760export declare namespace interfaces.alexa.presentation.apl {
6761 /**
6762 *
6763 * @interface
6764 */
6765 interface UserEvent {
6766 'type': 'Alexa.Presentation.APL.UserEvent';
6767 /**
6768 * Represents the unique identifier for the specific request.
6769 */
6770 'requestId': string;
6771 /**
6772 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
6773 */
6774 'timestamp': string;
6775 /**
6776 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
6777 */
6778 'locale'?: string;
6779 /**
6780 * A unique token for the active presentation.
6781 */
6782 'token'?: string;
6783 /**
6784 * The array of argument data to pass to Alexa.
6785 */
6786 'arguments'?: Array<any>;
6787 /**
6788 * Meta-information about what caused the event to be generated.
6789 */
6790 'source'?: any;
6791 /**
6792 * Components associated with the request.
6793 */
6794 'components'?: any;
6795 }
6796}
6797export declare namespace interfaces.alexa.presentation.apl.listoperations {
6798 /**
6799 * Deletes an item at a specified index in a dynamicIndexList.
6800 * @interface
6801 */
6802 interface DeleteItemOperation {
6803 'type': 'DeleteItem';
6804 /**
6805 * The position of the item in the dynamicIndexList to which the operation is to be applied. For inserts and deletes that operate on multiple items, this value represents the starting index, with onward inserts/deletes applying to consecutively increasing positions.
6806 */
6807 'index': number;
6808 }
6809}
6810export declare namespace interfaces.alexa.presentation.apl.listoperations {
6811 /**
6812 * Deletes items at consecutive indexes in a dynamicIndexList.
6813 * @interface
6814 */
6815 interface DeleteMultipleItemsOperation {
6816 'type': 'DeleteMultipleItems';
6817 /**
6818 * The position of the item in the dynamicIndexList to which the operation is to be applied. For inserts and deletes that operate on multiple items, this value represents the starting index, with onward inserts/deletes applying to consecutively increasing positions.
6819 */
6820 'index': number;
6821 /**
6822 * The number of items to delete.
6823 */
6824 'count': number;
6825 }
6826}
6827export declare namespace interfaces.alexa.presentation.apl.listoperations {
6828 /**
6829 * Inserts a new item at a specified index in a dynamicIndexList.
6830 * @interface
6831 */
6832 interface InsertItemOperation {
6833 'type': 'InsertItem';
6834 /**
6835 * The position of the item in the dynamicIndexList to which the operation is to be applied. For inserts and deletes that operate on multiple items, this value represents the starting index, with onward inserts/deletes applying to consecutively increasing positions.
6836 */
6837 'index': number;
6838 /**
6839 * The new item to be inserted.
6840 */
6841 'item': any;
6842 }
6843}
6844export declare namespace interfaces.alexa.presentation.apl.listoperations {
6845 /**
6846 * Inserts an array of items into consecutive indexes in a dynamicIndexList.
6847 * @interface
6848 */
6849 interface InsertMultipleItemsOperation {
6850 'type': 'InsertMultipleItems';
6851 /**
6852 * The position of the item in the dynamicIndexList to which the operation is to be applied. For inserts and deletes that operate on multiple items, this value represents the starting index, with onward inserts/deletes applying to consecutively increasing positions.
6853 */
6854 'index': number;
6855 /**
6856 * The new items to be inserted.
6857 */
6858 'items': Array<any>;
6859 }
6860}
6861export declare namespace interfaces.alexa.presentation.apl.listoperations {
6862 /**
6863 * Sets an item at a specified index in a dynamicIndexList.
6864 * @interface
6865 */
6866 interface SetItemOperation {
6867 'type': 'SetItem';
6868 /**
6869 * The position of the item in the dynamicIndexList to which the operation is to be applied. For inserts and deletes that operate on multiple items, this value represents the starting index, with onward inserts/deletes applying to consecutively increasing positions.
6870 */
6871 'index': number;
6872 /**
6873 * The replacement item.
6874 */
6875 'item': any;
6876 }
6877}
6878export declare namespace interfaces.alexa.presentation.apla {
6879 /**
6880 * This error type occurs when the cloud fails to retrieve an audio file from a remote source, such as one specified from within an Audio component.
6881 * @interface
6882 */
6883 interface AudioSourceRuntimeError {
6884 'type': 'AUDIO_SOURCE_ERROR';
6885 /**
6886 * A human-readable description of the error.
6887 */
6888 'message': string;
6889 'reason': interfaces.alexa.presentation.apla.AudioSourceErrorReason;
6890 }
6891}
6892export declare namespace interfaces.alexa.presentation.apla {
6893 /**
6894 * This error type occurs when the cloud fails to render due to an incorrect or malformed document or data sources.
6895 * @interface
6896 */
6897 interface DocumentRuntimeError {
6898 'type': 'DOCUMENT_ERROR';
6899 /**
6900 * A human-readable description of the error.
6901 */
6902 'message': string;
6903 'reason': interfaces.alexa.presentation.apla.DocumentErrorReason;
6904 }
6905}
6906export declare namespace interfaces.alexa.presentation.apla {
6907 /**
6908 * This error type occurs when the cloud fails to execute a Link typed document.
6909 * @interface
6910 */
6911 interface LinkRuntimeError {
6912 'type': 'LINK_ERROR';
6913 /**
6914 * A human-readable description of the error.
6915 */
6916 'message': string;
6917 'reason': interfaces.alexa.presentation.apla.LinkErrorReason;
6918 }
6919}
6920export declare namespace interfaces.alexa.presentation.apla {
6921 /**
6922 *
6923 * @interface
6924 */
6925 interface RenderDocumentDirective {
6926 'type': 'Alexa.Presentation.APLA.RenderDocument';
6927 /**
6928 * A unique identifier for the presentation.
6929 */
6930 'token'?: string;
6931 /**
6932 * Depending on the document type, it represents either an entire APLA document or a reference Link to the document. In a Link object, the value of the 'src' should follow a URI format defined like 'doc://alexa/apla/documents/<document_id>'. The 'document_id' is a reference to the APLA document that the developer stores through APLA Authoring Tool.
6933 */
6934 'document'?: {
6935 [key: string]: any;
6936 };
6937 /**
6938 * Data sources to bind to the document when rendering.
6939 */
6940 'datasources'?: {
6941 [key: string]: any;
6942 };
6943 }
6944}
6945export declare namespace interfaces.alexa.presentation.apla {
6946 /**
6947 * This error type occurs when the the cloud based audio mixing service fails to render the audio due to service or user failure.
6948 * @interface
6949 */
6950 interface RenderRuntimeError {
6951 'type': 'RENDER_ERROR';
6952 /**
6953 * A human-readable description of the error.
6954 */
6955 'message': string;
6956 'reason': interfaces.alexa.presentation.apla.RenderErrorReason;
6957 }
6958}
6959export declare namespace interfaces.alexa.presentation.apla {
6960 /**
6961 * Notifies the skill of any errors in APLA functionality.
6962 * @interface
6963 */
6964 interface RuntimeErrorEvent {
6965 'type': 'Alexa.Presentation.APLA.RuntimeError';
6966 /**
6967 * Represents the unique identifier for the specific request.
6968 */
6969 'requestId': string;
6970 /**
6971 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
6972 */
6973 'timestamp': string;
6974 /**
6975 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
6976 */
6977 'locale'?: string;
6978 /**
6979 * The unique identifier of the presentation in which the error occurred.
6980 */
6981 'token': string;
6982 /**
6983 * An array of errors encountered while running the APLA presentation.
6984 */
6985 'errors': Array<interfaces.alexa.presentation.apla.RuntimeError>;
6986 }
6987}
6988export declare namespace interfaces.alexa.presentation.aplt {
6989 /**
6990 * Automatically progress through a series of pages displayed in a Pager component. The AutoPage command finishes after the last page has been displayed for the requested time period.
6991 * @interface
6992 */
6993 interface AutoPageCommand {
6994 'type': 'AutoPage';
6995 /**
6996 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
6997 */
6998 'delay'?: number;
6999 /**
7000 * A user-provided description of this command.
7001 */
7002 'description'?: string;
7003 /**
7004 * If true, disable the Interaction Timer.
7005 */
7006 'screenLock'?: boolean;
7007 /**
7008 * A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
7009 */
7010 'when'?: boolean | string;
7011 /**
7012 * The id of the Pager component.
7013 */
7014 'componentId': string;
7015 /**
7016 * Number of pages to display. Defaults to all of them.
7017 */
7018 'count'?: number | string;
7019 /**
7020 * Time to wait between pages (in milliseconds). Defaults to 0.
7021 */
7022 'duration'?: number | string;
7023 }
7024}
7025export declare namespace interfaces.alexa.presentation.aplt {
7026 /**
7027 * Alexa.Presentation.APLT.ExecuteCommands directive used to send APL-T commands to a device.
7028 * @interface
7029 */
7030 interface ExecuteCommandsDirective {
7031 'type': 'Alexa.Presentation.APLT.ExecuteCommands';
7032 /**
7033 * List of Command instances
7034 */
7035 'commands': Array<interfaces.alexa.presentation.aplt.Command>;
7036 /**
7037 * A skill defined token, unique for each presentation. Must match the token provided by the skill in the RenderDocument directive used to render the original APL document.
7038 */
7039 'token': string;
7040 }
7041}
7042export declare namespace interfaces.alexa.presentation.aplt {
7043 /**
7044 * The idle command does nothing. It may be a placeholder or used to insert a calculated delay in a longer series of commands.
7045 * @interface
7046 */
7047 interface IdleCommand {
7048 'type': 'Idle';
7049 /**
7050 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
7051 */
7052 'delay'?: number;
7053 /**
7054 * A user-provided description of this command.
7055 */
7056 'description'?: string;
7057 /**
7058 * If true, disable the Interaction Timer.
7059 */
7060 'screenLock'?: boolean;
7061 /**
7062 * A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
7063 */
7064 'when'?: boolean | string;
7065 }
7066}
7067export declare namespace interfaces.alexa.presentation.aplt {
7068 /**
7069 * Execute a series of commands in parallel. The parallel command starts executing all child command simultaneously. The parallel command is considered finished when all of its child commands have finished. When the parallel command is terminated early, all currently executing commands are terminated.
7070 * @interface
7071 */
7072 interface ParallelCommand {
7073 'type': 'Parallel';
7074 /**
7075 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
7076 */
7077 'delay'?: number;
7078 /**
7079 * A user-provided description of this command.
7080 */
7081 'description'?: string;
7082 /**
7083 * If true, disable the Interaction Timer.
7084 */
7085 'screenLock'?: boolean;
7086 /**
7087 * A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
7088 */
7089 'when'?: boolean | string;
7090 /**
7091 * An un-ordered array of commands to execute in parallel. Once all commands have finished executing the parallel command finishes. Please note that the delay of parallel command and the delay of each command are additive.
7092 */
7093 'commands': Array<interfaces.alexa.presentation.aplt.Command>;
7094 }
7095}
7096export declare namespace interfaces.alexa.presentation.aplt {
7097 /**
7098 *
7099 * @interface
7100 */
7101 interface RenderDocumentDirective {
7102 'type': 'Alexa.Presentation.APLT.RenderDocument';
7103 /**
7104 * A unique identifier for the presentation.
7105 */
7106 'token'?: string;
7107 /**
7108 * One of supported profiles in character display. Default value is NONE.
7109 */
7110 'targetProfile'?: interfaces.alexa.presentation.aplt.TargetProfile;
7111 /**
7112 * Depending on the document type, it represents either an entire APLT document or a reference Link to the document. In a Link object, the value of the 'src' should follow a URI format defined like 'doc://alexa/aplt/documents/<document_id>'. The 'document_id' is a reference to the APLT document that the developer stores through APL Authoring Tool.
7113 */
7114 'document'?: {
7115 [key: string]: any;
7116 };
7117 /**
7118 * Data sources to bind to the document when rendering.
7119 */
7120 'datasources'?: {
7121 [key: string]: any;
7122 };
7123 }
7124}
7125export declare namespace interfaces.alexa.presentation.aplt {
7126 /**
7127 * Scroll a ScrollView or Sequence forward or backward by a number of pages. The Scroll command has the following properties in addition to the regular command properties.
7128 * @interface
7129 */
7130 interface ScrollCommand {
7131 'type': 'Scroll';
7132 /**
7133 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
7134 */
7135 'delay'?: number;
7136 /**
7137 * A user-provided description of this command.
7138 */
7139 'description'?: string;
7140 /**
7141 * If true, disable the Interaction Timer.
7142 */
7143 'screenLock'?: boolean;
7144 /**
7145 * A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
7146 */
7147 'when'?: boolean | string;
7148 /**
7149 * The number of pages to scroll. Defaults to 1.
7150 */
7151 'distance'?: number | string;
7152 /**
7153 * The id of the component.
7154 */
7155 'componentId': string;
7156 }
7157}
7158export declare namespace interfaces.alexa.presentation.aplt {
7159 /**
7160 * The SendEvent command allows the APL author to generate and send an event to Alexa.
7161 * @interface
7162 */
7163 interface SendEventCommand {
7164 'type': 'SendEvent';
7165 /**
7166 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
7167 */
7168 'delay'?: number;
7169 /**
7170 * A user-provided description of this command.
7171 */
7172 'description'?: string;
7173 /**
7174 * If true, disable the Interaction Timer.
7175 */
7176 'screenLock'?: boolean;
7177 /**
7178 * A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
7179 */
7180 'when'?: boolean | string;
7181 /**
7182 * An array of argument data to pass to Alexa.
7183 */
7184 'arguments'?: Array<string>;
7185 /**
7186 * An array of components to extract value data from and provide to Alexa.
7187 */
7188 'components'?: Array<string>;
7189 }
7190}
7191export declare namespace interfaces.alexa.presentation.aplt {
7192 /**
7193 * A sequential command executes a series of commands in order. The sequential command executes the command list in order, waiting for the previous command to finish before executing the next. The sequential command is finished when all of its child commands have finished. When the Sequential command is terminated early, the currently executing command is terminated and no further commands are executed.
7194 * @interface
7195 */
7196 interface SequentialCommand {
7197 'type': 'Sequential';
7198 /**
7199 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
7200 */
7201 'delay'?: number;
7202 /**
7203 * A user-provided description of this command.
7204 */
7205 'description'?: string;
7206 /**
7207 * If true, disable the Interaction Timer.
7208 */
7209 'screenLock'?: boolean;
7210 /**
7211 * A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
7212 */
7213 'when'?: boolean | string;
7214 /**
7215 * An ordered list of commands to execute if this sequence is prematurely terminated.
7216 */
7217 'catch'?: Array<interfaces.alexa.presentation.aplt.Command>;
7218 /**
7219 * An array of commands to execute. The commands execute in order; each command must finish before the next can begin. Please note that the delay of sequential command and the delay of the first command in the sequence are additive.
7220 */
7221 'commands': Array<interfaces.alexa.presentation.aplt.Command>;
7222 /**
7223 * An ordered list of commands to execute after the normal commands and the catch commands.
7224 */
7225 'finally'?: Array<interfaces.alexa.presentation.aplt.Command>;
7226 /**
7227 * The number of times to repeat this series of commands. Defaults to 0. Negative values will be ignored. Note that the delay assigned to overall sequential command only applies the first time. For example, in the sample sequential command below the first SendEvent fires at 3000 milliseconds, the second at 5000, the first SendEvent fires again at 7000 milliseconds, and so forth. {\"type\": \"Sequential\",\"delay\": 1000,\"repeatCount\": 2,\"commands\": [{ \"type\": \"SendEvent\",\"delay\": 2000},{\"type\": \"SendEvent\",\"delay\": 2000}]}
7228 */
7229 'repeatCount'?: number | string;
7230 }
7231}
7232export declare namespace interfaces.alexa.presentation.aplt {
7233 /**
7234 * Change the page displayed in a Pager component. The SetPage command finishes when the item is fully in view.
7235 * @interface
7236 */
7237 interface SetPageCommand {
7238 'type': 'SetPage';
7239 /**
7240 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
7241 */
7242 'delay'?: number;
7243 /**
7244 * A user-provided description of this command.
7245 */
7246 'description'?: string;
7247 /**
7248 * If true, disable the Interaction Timer.
7249 */
7250 'screenLock'?: boolean;
7251 /**
7252 * A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
7253 */
7254 'when'?: boolean | string;
7255 /**
7256 * The id of the Pager component.
7257 */
7258 'componentId': string;
7259 'position'?: interfaces.alexa.presentation.aplt.Position;
7260 /**
7261 * The distance to move. May be an absolute value or a relative value.
7262 */
7263 'value': number | string;
7264 }
7265}
7266export declare namespace interfaces.alexa.presentation.aplt {
7267 /**
7268 * Change a dynamic property of a component without redrawing the screen.
7269 * @interface
7270 */
7271 interface SetValueCommand {
7272 'type': 'SetValue';
7273 /**
7274 * The delay in milliseconds before this command starts executing; must be non-negative. Defaults to 0.
7275 */
7276 'delay'?: number;
7277 /**
7278 * A user-provided description of this command.
7279 */
7280 'description'?: string;
7281 /**
7282 * If true, disable the Interaction Timer.
7283 */
7284 'screenLock'?: boolean;
7285 /**
7286 * A conditional expression to be evaluated in device. If false, the execution of the command is skipped. Defaults to true.
7287 */
7288 'when'?: boolean | string;
7289 /**
7290 * The id of the component whose value to set.
7291 */
7292 'componentId'?: string;
7293 /**
7294 * The name of the property to set.
7295 */
7296 'property': string;
7297 /**
7298 * The property value to set.
7299 */
7300 'value': string;
7301 }
7302}
7303export declare namespace interfaces.alexa.presentation.aplt {
7304 /**
7305 *
7306 * @interface
7307 */
7308 interface UserEvent {
7309 'type': 'Alexa.Presentation.APLT.UserEvent';
7310 /**
7311 * Represents the unique identifier for the specific request.
7312 */
7313 'requestId': string;
7314 /**
7315 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
7316 */
7317 'timestamp': string;
7318 /**
7319 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
7320 */
7321 'locale'?: string;
7322 /**
7323 * A unique token for the active presentation.
7324 */
7325 'token'?: string;
7326 /**
7327 * The array of argument data to pass to Alexa.
7328 */
7329 'arguments'?: Array<any>;
7330 /**
7331 * Meta-information about what caused the event to be generated.
7332 */
7333 'source'?: any;
7334 }
7335}
7336export declare namespace interfaces.alexa.presentation.html {
7337 /**
7338 * The HandleMessage directive sends a message to a skill's web application that runs on the device browser.
7339 * @interface
7340 */
7341 interface HandleMessageDirective {
7342 'type': 'Alexa.Presentation.HTML.HandleMessage';
7343 /**
7344 * A free-form object containing data to deliver to a skill's HTML application running the device. Maximum size 18 KB.
7345 */
7346 'message': any;
7347 /**
7348 * An array of objects for performing text-to-speech transformations with message data
7349 */
7350 'transformers'?: Array<interfaces.alexa.presentation.html.Transformer>;
7351 }
7352}
7353export declare namespace interfaces.alexa.presentation.html {
7354 /**
7355 * The Message request sends a message to the skill lambda.
7356 * @interface
7357 */
7358 interface MessageRequest {
7359 'type': 'Alexa.Presentation.HTML.Message';
7360 /**
7361 * Represents the unique identifier for the specific request.
7362 */
7363 'requestId': string;
7364 /**
7365 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
7366 */
7367 'timestamp': string;
7368 /**
7369 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
7370 */
7371 'locale'?: string;
7372 /**
7373 * A free-form object containing data from a skill's HTML application to deliver to the Alexa cloud. Maximum size 18 KB.
7374 */
7375 'message': any;
7376 }
7377}
7378export declare namespace interfaces.alexa.presentation.html {
7379 /**
7380 * The RuntimeError request occurs when the device software encounters an error with loading a skill's web application.
7381 * @interface
7382 */
7383 interface RuntimeErrorRequest {
7384 'type': 'Alexa.Presentation.HTML.RuntimeError';
7385 /**
7386 * Represents the unique identifier for the specific request.
7387 */
7388 'requestId': string;
7389 /**
7390 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
7391 */
7392 'timestamp': string;
7393 /**
7394 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
7395 */
7396 'locale'?: string;
7397 'error': interfaces.alexa.presentation.html.RuntimeError;
7398 }
7399}
7400export declare namespace interfaces.alexa.presentation.html {
7401 /**
7402 * The Start directive provides the data necessary to load an HTML page on the target device.
7403 * @interface
7404 */
7405 interface StartDirective {
7406 'type': 'Alexa.Presentation.HTML.Start';
7407 /**
7408 * Optional startup data which will be made available to the runtime for skill startup. Maximum size: 18 KB
7409 */
7410 'data'?: any;
7411 /**
7412 * An array of objects for performing text-to-speech transformations with message data
7413 */
7414 'transformers'?: Array<interfaces.alexa.presentation.html.Transformer>;
7415 'request': interfaces.alexa.presentation.html.StartRequest;
7416 'configuration': interfaces.alexa.presentation.html.Configuration;
7417 }
7418}
7419export declare namespace interfaces.alexa.smartvision.snapshotprovider {
7420 /**
7421 * This directive is used to request latest snapshot from camera skill on a particular endpoint.
7422 * @interface
7423 */
7424 interface GetSnapshotDirective {
7425 'type': 'Alexa.SmartVision.SnapshotProvider.GetSnapshotDirective';
7426 /**
7427 * This property defines that an on-demand snapshot is preferred over a cached snapshot from camera skill.
7428 */
7429 'preferOnDemandSnapshot'?: boolean;
7430 }
7431}
7432export declare namespace interfaces.amazonpay.model.request {
7433 /**
7434 * This is an object to set the attributes specified in the AuthorizeAttributes table. See the “AuthorizationDetails” section of the Amazon Pay API reference guide for details about this object.
7435 * @interface
7436 */
7437 interface AuthorizeAttributes {
7438 '@type': 'AuthorizeAttributes';
7439 /**
7440 * This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
7441 */
7442 'authorizationReferenceId': string;
7443 'authorizationAmount': interfaces.amazonpay.model.request.Price;
7444 /**
7445 * The maximum number of minutes allocated for the Authorize operation call to be processed. After this the authorization is automatically declined and you cannot capture funds against the authorization. The default value for Alexa transactions is 0. In order to speed up checkout time for voice users we recommend to not change this value.
7446 */
7447 'transactionTimeout'?: number;
7448 /**
7449 * A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
7450 */
7451 'sellerAuthorizationNote'?: string;
7452 /**
7453 * The description to be shown on the user's payment instrument statement if AuthorizeAndCapture is chosen. Format of soft descriptor sent to the payment processor is \"AMZ* <soft descriptor specified here>\". Default is \"AMZ*<SELLER_NAME> amzn.com/ pmts WA\". Maximum length can be 16 characters.
7454 */
7455 'softDescriptor'?: string;
7456 /**
7457 * Version of the Amazon Pay Entity. Can be 1 or greater.
7458 */
7459 '@version': string;
7460 }
7461}
7462export declare namespace interfaces.amazonpay.model.request {
7463 /**
7464 * The merchant can choose to set the attributes specified in the BillingAgreementAttributes.
7465 * @interface
7466 */
7467 interface BillingAgreementAttributes {
7468 '@type': 'BillingAgreementAttributes';
7469 /**
7470 * Represents the SellerId of the Solution Provider that developed the eCommerce platform. This value is only used by Solution Providers, for whom it is required. It should not be provided by merchants creating their own custom integration. Do not specify the SellerId of the merchant for this request parameter. If you are a merchant, do not enter a PlatformId.
7471 */
7472 'platformId'?: string;
7473 /**
7474 * Represents a description of the billing agreement that is displayed in emails to the buyer.
7475 */
7476 'sellerNote'?: string;
7477 'sellerBillingAgreementAttributes'?: interfaces.amazonpay.model.request.SellerBillingAgreementAttributes;
7478 'billingAgreementType'?: interfaces.amazonpay.model.request.BillingAgreementType;
7479 'subscriptionAmount'?: interfaces.amazonpay.model.request.Price;
7480 /**
7481 * Version of the Amazon Pay Entity. Can be 1 or greater.
7482 */
7483 '@version': string;
7484 }
7485}
7486export declare namespace interfaces.amazonpay.model.request {
7487 /**
7488 * This request object specifies amount and currency authorized/captured.
7489 * @interface
7490 */
7491 interface Price {
7492 '@type': 'Price';
7493 /**
7494 * Amount authorized/captured.
7495 */
7496 'amount': string;
7497 /**
7498 * Currency code for the amount.
7499 */
7500 'currencyCode': string;
7501 /**
7502 * Version of the Amazon Pay Entity. Can be 1 or greater.
7503 */
7504 '@version': string;
7505 }
7506}
7507export declare namespace interfaces.amazonpay.model.request {
7508 /**
7509 * This is required only for Ecommerce provider (Solution provider) use cases.
7510 * @interface
7511 */
7512 interface ProviderAttributes {
7513 '@type': 'ProviderAttributes';
7514 /**
7515 * Solution provider ID.
7516 */
7517 'providerId': string;
7518 /**
7519 * List of provider credit.
7520 */
7521 'providerCreditList': Array<interfaces.amazonpay.model.request.ProviderCredit>;
7522 /**
7523 * Version of the Amazon Pay Entity. Can be 1 or greater.
7524 */
7525 '@version': string;
7526 }
7527}
7528export declare namespace interfaces.amazonpay.model.request {
7529 /**
7530 *
7531 * @interface
7532 */
7533 interface ProviderCredit {
7534 '@type': 'ProviderCredit';
7535 /**
7536 * This is required only for Ecommerce provider (Solution provider) use cases.
7537 */
7538 'providerId'?: string;
7539 'credit'?: interfaces.amazonpay.model.request.Price;
7540 /**
7541 * Version of the Amazon Pay Entity. Can be 1 or greater.
7542 */
7543 '@version': string;
7544 }
7545}
7546export declare namespace interfaces.amazonpay.model.request {
7547 /**
7548 * Provides more context about the billing agreement that is represented by this Billing Agreement object.
7549 * @interface
7550 */
7551 interface SellerBillingAgreementAttributes {
7552 '@type': 'SellerBillingAgreementAttributes';
7553 /**
7554 * The merchant-specified identifier of this billing agreement. At least one request parameter must be specified. Amazon recommends that you use only the following characters:- lowercase a-z, uppercase A-Z, numbers 0-9, dash (-), underscore (_).
7555 */
7556 'sellerBillingAgreementId'?: string;
7557 /**
7558 * The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings > Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
7559 */
7560 'storeName'?: string;
7561 /**
7562 * Any additional information that you wish to include with this billing agreement. At least one request parameter must be specified.
7563 */
7564 'customInformation'?: string;
7565 /**
7566 * Version of the Amazon Pay Entity. Can be 1 or greater.
7567 */
7568 '@version': string;
7569 }
7570}
7571export declare namespace interfaces.amazonpay.model.request {
7572 /**
7573 * This object includes elements shown to buyers in emails and in their transaction history. See the “SellerOrderAttributes” section of the Amazon Pay API reference guide for details about this object.
7574 * @interface
7575 */
7576 interface SellerOrderAttributes {
7577 '@type': 'SellerOrderAttributes';
7578 /**
7579 * The merchant-specified identifier of this order. This is shown to the buyer in their emails and transaction history on the Amazon Pay website.
7580 */
7581 'sellerOrderId'?: string;
7582 /**
7583 * The identifier of the store from which the order was placed. This overrides the default value in Seller Central under Settings > Account Settings. It is displayed to the buyer in their emails and transaction history on the Amazon Payments website.
7584 */
7585 'storeName'?: string;
7586 /**
7587 * Any additional information that you want to include with this order reference.
7588 */
7589 'customInformation'?: string;
7590 /**
7591 * This represents a description of the order that is displayed in emails to the buyer.
7592 */
7593 'sellerNote'?: string;
7594 /**
7595 * Version of the Amazon Pay Entity. Can be 1 or greater.
7596 */
7597 '@version': string;
7598 }
7599}
7600export declare namespace interfaces.amazonpay.model.response {
7601 /**
7602 * This object encapsulates details about an Authorization object including the status, amount captured and fee charged.
7603 * @interface
7604 */
7605 interface AuthorizationDetails {
7606 /**
7607 * This is AmazonPay generated identifier for this authorization transaction.
7608 */
7609 'amazonAuthorizationId'?: string;
7610 /**
7611 * This is 3P seller's identifier for this authorization transaction. This identifier must be unique for all of your authorization transactions.
7612 */
7613 'authorizationReferenceId'?: string;
7614 /**
7615 * A description for the transaction that is included in emails to the user. Appears only when AuthorizeAndCapture is chosen.
7616 */
7617 'sellerAuthorizationNote'?: string;
7618 'authorizationAmount'?: interfaces.amazonpay.model.response.Price;
7619 'capturedAmount'?: interfaces.amazonpay.model.response.Price;
7620 'authorizationFee'?: interfaces.amazonpay.model.response.Price;
7621 /**
7622 * list of AmazonCaptureId identifiers that have been requested on this Authorization object.
7623 */
7624 'idList'?: Array<string>;
7625 /**
7626 * This is the time at which the authorization was created.
7627 */
7628 'creationTimestamp'?: string;
7629 /**
7630 * This is the time at which the authorization expires.
7631 */
7632 'expirationTimestamp'?: string;
7633 'authorizationStatus'?: interfaces.amazonpay.model.response.AuthorizationStatus;
7634 /**
7635 * This indicates whether an authorization resulted in a soft decline.
7636 */
7637 'softDecline'?: boolean;
7638 /**
7639 * This indicates whether a direct capture against the payment contract was specified.
7640 */
7641 'captureNow'?: boolean;
7642 /**
7643 * This is the description to be shown on the buyer's payment instrument statement if AuthorizeAndCapture was chosen.
7644 */
7645 'softDescriptor'?: string;
7646 'authorizationBillingAddress'?: interfaces.amazonpay.model.response.Destination;
7647 }
7648}
7649export declare namespace interfaces.amazonpay.model.response {
7650 /**
7651 * Indicates the current status of an Authorization object, a Capture object, or a Refund object.
7652 * @interface
7653 */
7654 interface AuthorizationStatus {
7655 'state'?: interfaces.amazonpay.model.response.State;
7656 /**
7657 * The reason that the Authorization object, Capture object, or Refund object is in the current state. For more information, see - https://pay.amazon.com/us/developer/documentation/apireference/201752950
7658 */
7659 'reasonCode'?: string;
7660 /**
7661 * Reason desciption corresponding to the reason code
7662 */
7663 'reasonDescription'?: string;
7664 /**
7665 * A timestamp that indicates the time when the authorization, capture, or refund state was last updated. In ISO 8601 format
7666 */
7667 'lastUpdateTimestamp'?: string;
7668 }
7669}
7670export declare namespace interfaces.amazonpay.model.response {
7671 /**
7672 * The result attributes from successful SetupAmazonPay call.
7673 * @interface
7674 */
7675 interface BillingAgreementDetails {
7676 /**
7677 * Billing agreement id which can be used for one time and recurring purchases
7678 */
7679 'billingAgreementId': string;
7680 /**
7681 * Time at which billing agreement details created.
7682 */
7683 'creationTimestamp'?: string;
7684 /**
7685 * The default shipping address of the buyer. Returned if needAmazonShippingAddress is set to true.
7686 */
7687 'destination'?: interfaces.amazonpay.model.v1.Destination;
7688 /**
7689 * Merchant's preferred language of checkout.
7690 */
7691 'checkoutLanguage'?: string;
7692 'releaseEnvironment': interfaces.amazonpay.model.response.ReleaseEnvironment;
7693 'billingAgreementStatus': interfaces.amazonpay.model.v1.BillingAgreementStatus;
7694 /**
7695 * The Billing Address of the payment instrument associated with Billing Agreement.
7696 */
7697 'billingAddress'?: interfaces.amazonpay.model.response.Destination;
7698 }
7699}
7700export declare namespace interfaces.amazonpay.model.response {
7701 /**
7702 *
7703 * @interface
7704 */
7705 interface Destination {
7706 /**
7707 * The name or business name
7708 */
7709 'name'?: string;
7710 /**
7711 * The company name
7712 */
7713 'companyName'?: string;
7714 /**
7715 * The first line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
7716 */
7717 'addressLine1'?: string;
7718 /**
7719 * The second line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
7720 */
7721 'addressLine2'?: string;
7722 /**
7723 * The third line of the address. At least one AddressLine (AddressLine1, AddressLine2, or AddressLine3) is required.
7724 */
7725 'addressLine3'?: string;
7726 /**
7727 * The city
7728 */
7729 'city'?: string;
7730 /**
7731 * The district or County
7732 */
7733 'districtOrCounty'?: string;
7734 /**
7735 * The state or region. This element is free text and can be either a 2-character code, fully spelled out, or abbreviated. Required. Note :- This response element is returned only in the U.S.
7736 */
7737 'stateOrRegion'?: string;
7738 /**
7739 * The postal code.
7740 */
7741 'postalCode'?: string;
7742 /**
7743 * The country code, in ISO 3166 format
7744 */
7745 'countryCode'?: string;
7746 /**
7747 * The phone number
7748 */
7749 'phone'?: string;
7750 }
7751}
7752export declare namespace interfaces.amazonpay.model.response {
7753 /**
7754 * This response object specifies amount and currency authorized/captured.
7755 * @interface
7756 */
7757 interface Price {
7758 /**
7759 * Amount authorized/captured.
7760 */
7761 'amount': string;
7762 /**
7763 * Currency code for the amount.
7764 */
7765 'currencyCode': string;
7766 }
7767}
7768export declare namespace interfaces.amazonpay.request {
7769 /**
7770 * Charge Amazon Pay Request Object.
7771 * @interface
7772 */
7773 interface ChargeAmazonPayRequest {
7774 '@type': 'ChargeAmazonPayRequest';
7775 /**
7776 * Version of the Amazon Pay Entity. Can be 1 or greater.
7777 */
7778 '@version': string;
7779 /**
7780 * The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
7781 */
7782 'sellerId': string;
7783 /**
7784 * The payment contract i.e. billing agreement created for the user.
7785 */
7786 'billingAgreementId': string;
7787 'paymentAction': interfaces.amazonpay.model.request.PaymentAction;
7788 'authorizeAttributes': interfaces.amazonpay.model.request.AuthorizeAttributes;
7789 'sellerOrderAttributes'?: interfaces.amazonpay.model.request.SellerOrderAttributes;
7790 'providerAttributes'?: interfaces.amazonpay.model.request.ProviderAttributes;
7791 }
7792}
7793export declare namespace interfaces.amazonpay.request {
7794 /**
7795 * Setup Amazon Pay Request Object.
7796 * @interface
7797 */
7798 interface SetupAmazonPayRequest {
7799 '@type': 'SetupAmazonPayRequest';
7800 /**
7801 * Version of the Amazon Pay Entity. Can be 1 or greater.
7802 */
7803 '@version': string;
7804 /**
7805 * The seller ID (also known as merchant ID). If you are an Ecommerce Provider (Solution Provider), please specify the ID of the merchant, not your provider ID.
7806 */
7807 'sellerId': string;
7808 /**
7809 * The country in which the merchant has registered, as an Amazon Payments legal entity.
7810 */
7811 'countryOfEstablishment': string;
7812 /**
7813 * The currency of the merchant’s ledger account.
7814 */
7815 'ledgerCurrency': string;
7816 /**
7817 * The merchant's preferred language for checkout.
7818 */
7819 'checkoutLanguage'?: string;
7820 'billingAgreementAttributes'?: interfaces.amazonpay.model.request.BillingAgreementAttributes;
7821 /**
7822 * To receive the default user shipping address in the response, set this parameter to true. Not required if a user shipping address is not required.
7823 */
7824 'needAmazonShippingAddress'?: boolean;
7825 /**
7826 * To test in Sandbox mode, set this parameter to true.
7827 */
7828 'sandboxMode'?: boolean;
7829 /**
7830 * Use this parameter to create a Sandbox payment object. In order to use this parameter, you first create a Sandbox user account in Seller Central. Then, pass the email address associated with that Sandbox user account.
7831 */
7832 'sandboxCustomerEmailId'?: string;
7833 }
7834}
7835export declare namespace interfaces.amazonpay.response {
7836 /**
7837 * Error response for SetupAmazonPay and ChargeAmazonPay calls.
7838 * @interface
7839 */
7840 interface AmazonPayErrorResponse {
7841 /**
7842 * Error code indicating the succinct cause of error
7843 */
7844 'errorCode': string;
7845 /**
7846 * Description of the error.
7847 */
7848 'errorMessage': string;
7849 }
7850}
7851export declare namespace interfaces.amazonpay.response {
7852 /**
7853 * Charge Amazon Pay Result Object. It is sent as part of the response to ChargeAmazonPayRequest.
7854 * @interface
7855 */
7856 interface ChargeAmazonPayResult {
7857 /**
7858 * The order reference identifier.
7859 */
7860 'amazonOrderReferenceId': string;
7861 'authorizationDetails': interfaces.amazonpay.model.response.AuthorizationDetails;
7862 }
7863}
7864export declare namespace interfaces.audioplayer {
7865 /**
7866 *
7867 * @interface
7868 */
7869 interface ClearQueueDirective {
7870 'type': 'AudioPlayer.ClearQueue';
7871 'clearBehavior'?: interfaces.audioplayer.ClearBehavior;
7872 }
7873}
7874export declare namespace interfaces.audioplayer {
7875 /**
7876 *
7877 * @interface
7878 */
7879 interface PlayDirective {
7880 'type': 'AudioPlayer.Play';
7881 'playBehavior'?: interfaces.audioplayer.PlayBehavior;
7882 'audioItem'?: interfaces.audioplayer.AudioItem;
7883 }
7884}
7885export declare namespace interfaces.audioplayer {
7886 /**
7887 *
7888 * @interface
7889 */
7890 interface PlaybackFailedRequest {
7891 'type': 'AudioPlayer.PlaybackFailed';
7892 /**
7893 * Represents the unique identifier for the specific request.
7894 */
7895 'requestId': string;
7896 /**
7897 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
7898 */
7899 'timestamp': string;
7900 /**
7901 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
7902 */
7903 'locale'?: string;
7904 'currentPlaybackState'?: interfaces.audioplayer.CurrentPlaybackState;
7905 'error'?: interfaces.audioplayer.Error;
7906 'token'?: string;
7907 }
7908}
7909export declare namespace interfaces.audioplayer {
7910 /**
7911 *
7912 * @interface
7913 */
7914 interface PlaybackFinishedRequest {
7915 'type': 'AudioPlayer.PlaybackFinished';
7916 /**
7917 * Represents the unique identifier for the specific request.
7918 */
7919 'requestId': string;
7920 /**
7921 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
7922 */
7923 'timestamp': string;
7924 /**
7925 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
7926 */
7927 'locale'?: string;
7928 'offsetInMilliseconds'?: number;
7929 'token'?: string;
7930 }
7931}
7932export declare namespace interfaces.audioplayer {
7933 /**
7934 *
7935 * @interface
7936 */
7937 interface PlaybackNearlyFinishedRequest {
7938 'type': 'AudioPlayer.PlaybackNearlyFinished';
7939 /**
7940 * Represents the unique identifier for the specific request.
7941 */
7942 'requestId': string;
7943 /**
7944 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
7945 */
7946 'timestamp': string;
7947 /**
7948 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
7949 */
7950 'locale'?: string;
7951 'offsetInMilliseconds'?: number;
7952 'token'?: string;
7953 }
7954}
7955export declare namespace interfaces.audioplayer {
7956 /**
7957 *
7958 * @interface
7959 */
7960 interface PlaybackStartedRequest {
7961 'type': 'AudioPlayer.PlaybackStarted';
7962 /**
7963 * Represents the unique identifier for the specific request.
7964 */
7965 'requestId': string;
7966 /**
7967 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
7968 */
7969 'timestamp': string;
7970 /**
7971 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
7972 */
7973 'locale'?: string;
7974 'offsetInMilliseconds'?: number;
7975 'token'?: string;
7976 }
7977}
7978export declare namespace interfaces.audioplayer {
7979 /**
7980 *
7981 * @interface
7982 */
7983 interface PlaybackStoppedRequest {
7984 'type': 'AudioPlayer.PlaybackStopped';
7985 /**
7986 * Represents the unique identifier for the specific request.
7987 */
7988 'requestId': string;
7989 /**
7990 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
7991 */
7992 'timestamp': string;
7993 /**
7994 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
7995 */
7996 'locale'?: string;
7997 'offsetInMilliseconds'?: number;
7998 'token'?: string;
7999 }
8000}
8001export declare namespace interfaces.audioplayer {
8002 /**
8003 *
8004 * @interface
8005 */
8006 interface StopDirective {
8007 'type': 'AudioPlayer.Stop';
8008 }
8009}
8010export declare namespace interfaces.connections {
8011 /**
8012 * This is the request object that a skill will receive as a result of Connections.SendRequest directive from sender skill.
8013 * @interface
8014 */
8015 interface ConnectionsRequest {
8016 'type': 'Connections.Request';
8017 /**
8018 * Represents the unique identifier for the specific request.
8019 */
8020 'requestId': string;
8021 /**
8022 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8023 */
8024 'timestamp': string;
8025 /**
8026 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8027 */
8028 'locale'?: string;
8029 /**
8030 * Name of the action sent by the referrer skill.
8031 */
8032 'name'?: string;
8033 /**
8034 * This is an object sent between the two skills for processing a ConnectionsRequest or ConnectionsResponse. This will always be a valid payload based on Action schema for the requester action.
8035 */
8036 'payload'?: {
8037 [key: string]: any;
8038 };
8039 }
8040}
8041export declare namespace interfaces.connections {
8042 /**
8043 * This is the request object that a skill will receive as a result of Connections.SendResponse directive from referrer skill.
8044 * @interface
8045 */
8046 interface ConnectionsResponse {
8047 'type': 'Connections.Response';
8048 /**
8049 * Represents the unique identifier for the specific request.
8050 */
8051 'requestId': string;
8052 /**
8053 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8054 */
8055 'timestamp': string;
8056 /**
8057 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8058 */
8059 'locale'?: string;
8060 'status'?: interfaces.connections.ConnectionsStatus;
8061 /**
8062 * Name of the action for which response is received.
8063 */
8064 'name'?: string;
8065 /**
8066 * This is an object sent from referrer skill as is.
8067 */
8068 'payload'?: {
8069 [key: string]: any;
8070 };
8071 /**
8072 * This is the token that the skill originally sent with the ConnectionsSendRequest directive.
8073 */
8074 'token'?: string;
8075 }
8076}
8077export declare namespace interfaces.connections {
8078 /**
8079 * This is the directive that a skill can send as part of their response to a session based request to execute a predefined Connections. This will also return a result to the referring skill. (No Guarantee response will be returned)
8080 * @interface
8081 */
8082 interface SendRequestDirective {
8083 'type': 'Connections.SendRequest';
8084 /**
8085 * This defines the name of the Connection skill is trying to execute. It must be a valid and supported Connection name.
8086 */
8087 'name': string;
8088 /**
8089 * This is an object sent between the two skills for processing a ConnectionsRequest or ConnectionsResponse. The contract for the object is based on the schema of the Action used in the SendRequestDirective. Invalid payloads will result in errors sent back to the referrer.
8090 */
8091 'payload'?: {
8092 [key: string]: any;
8093 };
8094 /**
8095 * This is an echo back string that skills send when during Connections.SendRequest directive. They will receive it when they get the ConnectionsResponse. It is never sent to the skill handling the request.
8096 */
8097 'token': string;
8098 }
8099}
8100export declare namespace interfaces.connections {
8101 /**
8102 * This is the directive that a skill can send as part of their response to a session based request to return a response to ConnectionsRequest.
8103 * @interface
8104 */
8105 interface SendResponseDirective {
8106 'type': 'Connections.SendResponse';
8107 'status': interfaces.connections.ConnectionsStatus;
8108 /**
8109 * This is an object sent to referrer skill as is.
8110 */
8111 'payload'?: {
8112 [key: string]: any;
8113 };
8114 }
8115}
8116export declare namespace interfaces.connections.V1 {
8117 /**
8118 * This is the directive that a skill can send as part of their response to a session based request to start a connection. A response will be returned to the skill when the connection is handled.
8119 * @interface
8120 */
8121 interface StartConnectionDirective {
8122 'type': 'Connections.StartConnection';
8123 /**
8124 * This defines the name and version of connection that the requester is trying to send. The format of the uri should follow this pattern: connection://connectionName/connectionVersion. Invalid uri will cause an error which will be sent back to the requester.
8125 */
8126 'uri': string;
8127 'onCompletion'?: interfaces.connections.OnCompletion;
8128 /**
8129 * This is the input to the connection that the requester is trying to send. It is predefined by the handler of the connection. If the input format is incorrect, an error will be sent to to the requester.
8130 */
8131 'input'?: {
8132 [key: string]: any;
8133 };
8134 /**
8135 * This is an echo back string that requester will receive it when it gets resumed. It is never sent to the handler of the connection.
8136 */
8137 'token'?: string;
8138 }
8139}
8140export declare namespace interfaces.connections.entities {
8141 /**
8142 * Postal Address
8143 * @interface
8144 */
8145 interface PostalAddress {
8146 '@type': 'PostalAddress';
8147 /**
8148 * version of the request
8149 */
8150 '@version': string;
8151 /**
8152 * street address
8153 */
8154 'streetAddress'?: string;
8155 /**
8156 * locality/city
8157 */
8158 'locality'?: string;
8159 /**
8160 * state/region
8161 */
8162 'region'?: string;
8163 /**
8164 * postal/zip code
8165 */
8166 'postalCode'?: string;
8167 /**
8168 * country
8169 */
8170 'country'?: string;
8171 }
8172}
8173export declare namespace interfaces.connections.entities {
8174 /**
8175 * Restaurant entity
8176 * @interface
8177 */
8178 interface Restaurant {
8179 '@type': 'Restaurant';
8180 /**
8181 * version of the request
8182 */
8183 '@version': string;
8184 /**
8185 * name of the restaurant
8186 */
8187 'name': string;
8188 /**
8189 * location
8190 */
8191 'location': interfaces.connections.entities.PostalAddress;
8192 }
8193}
8194export declare namespace interfaces.connections.requests {
8195 /**
8196 * Payload Request object for PrintImage
8197 * @interface
8198 */
8199 interface PrintImageRequest {
8200 '@type': 'PrintImageRequest';
8201 /**
8202 * version of the request
8203 */
8204 '@version': string;
8205 /**
8206 * title of the image
8207 */
8208 'title': string;
8209 /**
8210 * url of the image
8211 */
8212 'url': string;
8213 /**
8214 * description of the image
8215 */
8216 'description'?: string;
8217 /**
8218 * type of the image
8219 */
8220 'imageType': string;
8221 }
8222}
8223export declare namespace interfaces.connections.requests {
8224 /**
8225 * Payload Request object for PrintPDF
8226 * @interface
8227 */
8228 interface PrintPDFRequest {
8229 '@type': 'PrintPDFRequest';
8230 /**
8231 * version of the request
8232 */
8233 '@version': string;
8234 /**
8235 * title of the image
8236 */
8237 'title': string;
8238 /**
8239 * url of the image
8240 */
8241 'url': string;
8242 /**
8243 * description of the image
8244 */
8245 'description'?: string;
8246 }
8247}
8248export declare namespace interfaces.connections.requests {
8249 /**
8250 * Payload Request object for PrintWebPage
8251 * @interface
8252 */
8253 interface PrintWebPageRequest {
8254 '@type': 'PrintWebPageRequest';
8255 /**
8256 * version of the request
8257 */
8258 '@version': string;
8259 /**
8260 * title of the image
8261 */
8262 'title': string;
8263 /**
8264 * url of the image
8265 */
8266 'url': string;
8267 /**
8268 * description of the image
8269 */
8270 'description'?: string;
8271 }
8272}
8273export declare namespace interfaces.connections.requests {
8274 /**
8275 * ScheduleFoodEstablishmentReservationRequest for booking restaurant reservation
8276 * @interface
8277 */
8278 interface ScheduleFoodEstablishmentReservationRequest {
8279 '@type': 'ScheduleFoodEstablishmentReservationRequest';
8280 /**
8281 * version of the request
8282 */
8283 '@version': string;
8284 /**
8285 * start time of the reservation
8286 */
8287 'startTime'?: string;
8288 /**
8289 * party size
8290 */
8291 'partySize'?: string;
8292 /**
8293 * restaurant
8294 */
8295 'restaurant': interfaces.connections.entities.Restaurant;
8296 }
8297}
8298export declare namespace interfaces.connections.requests {
8299 /**
8300 * ScheduleTaxiReservationRequest for booking taxi reservation
8301 * @interface
8302 */
8303 interface ScheduleTaxiReservationRequest {
8304 '@type': 'ScheduleTaxiReservationRequest';
8305 /**
8306 * version of the request
8307 */
8308 '@version': string;
8309 /**
8310 * pickup time
8311 */
8312 'pickupTime'?: string;
8313 /**
8314 * party size
8315 */
8316 'partySize'?: string;
8317 /**
8318 * pick up location
8319 */
8320 'pickupLocation'?: interfaces.connections.entities.PostalAddress;
8321 /**
8322 * drop off location
8323 */
8324 'dropOffLocation'?: interfaces.connections.entities.PostalAddress;
8325 }
8326}
8327export declare namespace interfaces.conversations {
8328 /**
8329 *
8330 * @interface
8331 */
8332 interface APIInvocationRequest {
8333 'type': 'Dialog.API.Invoked';
8334 /**
8335 * Represents the unique identifier for the specific request.
8336 */
8337 'requestId': string;
8338 /**
8339 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8340 */
8341 'timestamp': string;
8342 /**
8343 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8344 */
8345 'locale'?: string;
8346 'apiRequest'?: interfaces.conversations.APIRequest;
8347 }
8348}
8349export declare namespace interfaces.conversations {
8350 /**
8351 *
8352 * @interface
8353 */
8354 interface ResetContextDirective {
8355 'type': 'Conversations.ResetContext';
8356 }
8357}
8358export declare namespace interfaces.customInterfaceController {
8359 /**
8360 * Skill receives this type of event when an event meets the filter conditions provided in the StartEventHandlerDirective.
8361 * @interface
8362 */
8363 interface EventsReceivedRequest {
8364 'type': 'CustomInterfaceController.EventsReceived';
8365 /**
8366 * Represents the unique identifier for the specific request.
8367 */
8368 'requestId': string;
8369 /**
8370 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8371 */
8372 'timestamp': string;
8373 /**
8374 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8375 */
8376 'locale'?: string;
8377 /**
8378 * Unique identifier associated with the Event Handler that dispatched this event.
8379 */
8380 'token'?: string;
8381 /**
8382 * A list of events that meet the filter criteria.
8383 */
8384 'events'?: Array<interfaces.customInterfaceController.Event>;
8385 }
8386}
8387export declare namespace interfaces.customInterfaceController {
8388 /**
8389 * This is the event received by the skill at expiry of an Event Handler.
8390 * @interface
8391 */
8392 interface ExpiredRequest {
8393 'type': 'CustomInterfaceController.Expired';
8394 /**
8395 * Represents the unique identifier for the specific request.
8396 */
8397 'requestId': string;
8398 /**
8399 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8400 */
8401 'timestamp': string;
8402 /**
8403 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8404 */
8405 'locale'?: string;
8406 /**
8407 * The unique token specified by the StartEventHandlerDirective.
8408 */
8409 'token'?: string;
8410 /**
8411 * The free form JSON object that the skill will receive if and only if the Event Handler duration expired.
8412 */
8413 'expirationPayload'?: any;
8414 }
8415}
8416export declare namespace interfaces.customInterfaceController {
8417 /**
8418 * The directive to be delivered to the gadgets. Each directive is targeted to one gadget (that is, one endpointId). To target the same directive to multiple gadgets, include one directive for each gadget in the response.
8419 * @interface
8420 */
8421 interface SendDirectiveDirective {
8422 'type': 'CustomInterfaceController.SendDirective';
8423 /**
8424 * The object that contains the header of the directive.
8425 */
8426 'header'?: interfaces.customInterfaceController.Header;
8427 /**
8428 * The free form JSON object.
8429 */
8430 'payload'?: any;
8431 /**
8432 * Identifies the gadget where the directive should be sent to. Each directive is targeted to one gadget (that is, one endpointId). If the same directive is be sent to multiple gadgets, include one directive for each gadget in the response.
8433 */
8434 'endpoint'?: interfaces.customInterfaceController.Endpoint;
8435 }
8436}
8437export declare namespace interfaces.customInterfaceController {
8438 /**
8439 * This directive configures and starts an event handler. This will enable the skill to receive Custom Events. A skill can only have one active Event Handler at a time.
8440 * @interface
8441 */
8442 interface StartEventHandlerDirective {
8443 'type': 'CustomInterfaceController.StartEventHandler';
8444 /**
8445 * A unique string to identify the Event Handler. This identifier is associated with all events dispatched by the Event Handler while it is active.
8446 */
8447 'token'?: string;
8448 'eventFilter'?: interfaces.customInterfaceController.EventFilter;
8449 'expiration'?: interfaces.customInterfaceController.Expiration;
8450 }
8451}
8452export declare namespace interfaces.customInterfaceController {
8453 /**
8454 * This directive stops a running Event Handler associated with the provided token. The Expiration payload will not be sent if this executed before the Event Handler duration expired.
8455 * @interface
8456 */
8457 interface StopEventHandlerDirective {
8458 'type': 'CustomInterfaceController.StopEventHandler';
8459 /**
8460 * Unique identifier required to close the Event Handler. This token must match the token used in the StartEventHandlerDirective.
8461 */
8462 'token'?: string;
8463 }
8464}
8465export declare namespace interfaces.display {
8466 /**
8467 *
8468 * @interface
8469 */
8470 interface BodyTemplate1 {
8471 'type': 'BodyTemplate1';
8472 'token'?: string;
8473 'backButton'?: interfaces.display.BackButtonBehavior;
8474 'backgroundImage'?: interfaces.display.Image;
8475 'title'?: string;
8476 'textContent'?: interfaces.display.TextContent;
8477 }
8478}
8479export declare namespace interfaces.display {
8480 /**
8481 *
8482 * @interface
8483 */
8484 interface BodyTemplate2 {
8485 'type': 'BodyTemplate2';
8486 'token'?: string;
8487 'backButton'?: interfaces.display.BackButtonBehavior;
8488 'backgroundImage'?: interfaces.display.Image;
8489 'image'?: interfaces.display.Image;
8490 'title'?: string;
8491 'textContent'?: interfaces.display.TextContent;
8492 }
8493}
8494export declare namespace interfaces.display {
8495 /**
8496 *
8497 * @interface
8498 */
8499 interface BodyTemplate3 {
8500 'type': 'BodyTemplate3';
8501 'token'?: string;
8502 'backButton'?: interfaces.display.BackButtonBehavior;
8503 'backgroundImage'?: interfaces.display.Image;
8504 'image'?: interfaces.display.Image;
8505 'title'?: string;
8506 'textContent'?: interfaces.display.TextContent;
8507 }
8508}
8509export declare namespace interfaces.display {
8510 /**
8511 *
8512 * @interface
8513 */
8514 interface BodyTemplate6 {
8515 'type': 'BodyTemplate6';
8516 'token'?: string;
8517 'backButton'?: interfaces.display.BackButtonBehavior;
8518 'backgroundImage'?: interfaces.display.Image;
8519 'textContent'?: interfaces.display.TextContent;
8520 'image'?: interfaces.display.Image;
8521 }
8522}
8523export declare namespace interfaces.display {
8524 /**
8525 *
8526 * @interface
8527 */
8528 interface BodyTemplate7 {
8529 'type': 'BodyTemplate7';
8530 'token'?: string;
8531 'backButton'?: interfaces.display.BackButtonBehavior;
8532 'title'?: string;
8533 'image'?: interfaces.display.Image;
8534 'backgroundImage'?: interfaces.display.Image;
8535 }
8536}
8537export declare namespace interfaces.display {
8538 /**
8539 *
8540 * @interface
8541 */
8542 interface ElementSelectedRequest {
8543 'type': 'Display.ElementSelected';
8544 /**
8545 * Represents the unique identifier for the specific request.
8546 */
8547 'requestId': string;
8548 /**
8549 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8550 */
8551 'timestamp': string;
8552 /**
8553 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8554 */
8555 'locale'?: string;
8556 'token': string;
8557 }
8558}
8559export declare namespace interfaces.display {
8560 /**
8561 *
8562 * @interface
8563 */
8564 interface HintDirective {
8565 'type': 'Hint';
8566 'hint': interfaces.display.Hint;
8567 }
8568}
8569export declare namespace interfaces.display {
8570 /**
8571 *
8572 * @interface
8573 */
8574 interface ListTemplate1 {
8575 'type': 'ListTemplate1';
8576 'token'?: string;
8577 'backButton'?: interfaces.display.BackButtonBehavior;
8578 'backgroundImage'?: interfaces.display.Image;
8579 'title'?: string;
8580 'listItems'?: Array<interfaces.display.ListItem>;
8581 }
8582}
8583export declare namespace interfaces.display {
8584 /**
8585 *
8586 * @interface
8587 */
8588 interface ListTemplate2 {
8589 'type': 'ListTemplate2';
8590 'token'?: string;
8591 'backButton'?: interfaces.display.BackButtonBehavior;
8592 'backgroundImage'?: interfaces.display.Image;
8593 'title'?: string;
8594 'listItems'?: Array<interfaces.display.ListItem>;
8595 }
8596}
8597export declare namespace interfaces.display {
8598 /**
8599 *
8600 * @interface
8601 */
8602 interface PlainText {
8603 'type': 'PlainText';
8604 'text': string;
8605 }
8606}
8607export declare namespace interfaces.display {
8608 /**
8609 *
8610 * @interface
8611 */
8612 interface PlainTextHint {
8613 'type': 'PlainText';
8614 'text': string;
8615 }
8616}
8617export declare namespace interfaces.display {
8618 /**
8619 *
8620 * @interface
8621 */
8622 interface RenderTemplateDirective {
8623 'type': 'Display.RenderTemplate';
8624 'template'?: interfaces.display.Template;
8625 }
8626}
8627export declare namespace interfaces.display {
8628 /**
8629 *
8630 * @interface
8631 */
8632 interface RichText {
8633 'type': 'RichText';
8634 'text': string;
8635 }
8636}
8637export declare namespace interfaces.gadgetController {
8638 /**
8639 * Sends Alexa a command to modify the behavior of connected Echo Buttons.
8640 * @interface
8641 */
8642 interface SetLightDirective {
8643 'type': 'GadgetController.SetLight';
8644 /**
8645 * The version of the directive. Must be set to 1.
8646 */
8647 'version'?: number;
8648 /**
8649 * The gadget IDs that will receive the command. An empty array, or leaving this parameter out, signifies that all gadgets will receive the command.
8650 */
8651 'targetGadgets'?: Array<string>;
8652 'parameters'?: services.gadgetController.SetLightParameters;
8653 }
8654}
8655export declare namespace interfaces.gameEngine {
8656 /**
8657 * Sent when the conditions of an Echo Button event that your skill defined were met.
8658 * @interface
8659 */
8660 interface InputHandlerEventRequest {
8661 'type': 'GameEngine.InputHandlerEvent';
8662 /**
8663 * Represents the unique identifier for the specific request.
8664 */
8665 'requestId': string;
8666 /**
8667 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8668 */
8669 'timestamp': string;
8670 /**
8671 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8672 */
8673 'locale'?: string;
8674 /**
8675 * The corresponding identifier of the request that started the input handler.
8676 */
8677 'originatingRequestId'?: string;
8678 'events'?: Array<services.gameEngine.InputHandlerEvent>;
8679 }
8680}
8681export declare namespace interfaces.gameEngine {
8682 /**
8683 *
8684 * @interface
8685 */
8686 interface StartInputHandlerDirective {
8687 'type': 'GameEngine.StartInputHandler';
8688 /**
8689 * The maximum run time for this Input Handler, in milliseconds. Although this parameter is required, you can specify events with conditions on which to end the Input Handler earlier.
8690 */
8691 'timeout'?: number;
8692 /**
8693 * Names for unknown gadget IDs to use in recognizers, allocated on a first-come, first-served basis.
8694 */
8695 'proxies'?: Array<string>;
8696 /**
8697 * Conditions that, at any moment, are either true or false. You use recognizers when you specify the conditions under which your skill is notified of Echo Button input.
8698 */
8699 'recognizers'?: {
8700 [key: string]: services.gameEngine.Recognizer;
8701 };
8702 /**
8703 * The logic that determines when your skill is notified of Echo Button input. Events are listed here as object keys, where the keys specify the name of an event.
8704 */
8705 'events'?: {
8706 [key: string]: services.gameEngine.Event;
8707 };
8708 }
8709}
8710export declare namespace interfaces.gameEngine {
8711 /**
8712 *
8713 * @interface
8714 */
8715 interface StopInputHandlerDirective {
8716 'type': 'GameEngine.StopInputHandler';
8717 /**
8718 * The `requestId` of the request that started the input handler.
8719 */
8720 'originatingRequestId'?: string;
8721 }
8722}
8723export declare namespace interfaces.geolocation {
8724 /**
8725 * The geolocation object used in the Context of API
8726 * @interface
8727 */
8728 interface GeolocationState {
8729 /**
8730 * Specifies the time when the geolocation data was last collected on the device.
8731 */
8732 'timestamp'?: string;
8733 'coordinate'?: interfaces.geolocation.Coordinate;
8734 'altitude'?: interfaces.geolocation.Altitude;
8735 'heading'?: interfaces.geolocation.Heading;
8736 'speed'?: interfaces.geolocation.Speed;
8737 'locationServices'?: interfaces.geolocation.LocationServices;
8738 }
8739}
8740export declare namespace interfaces.messaging {
8741 /**
8742 *
8743 * @interface
8744 */
8745 interface MessageReceivedRequest {
8746 'type': 'Messaging.MessageReceived';
8747 /**
8748 * Represents the unique identifier for the specific request.
8749 */
8750 'requestId': string;
8751 /**
8752 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8753 */
8754 'timestamp': string;
8755 /**
8756 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8757 */
8758 'locale'?: string;
8759 'message': {
8760 [key: string]: any;
8761 };
8762 }
8763}
8764export declare namespace interfaces.navigation.assistance {
8765 /**
8766 * New directive that Alexa will send to navigation engine to query road regulations about the road segments that the user is on.
8767 * @interface
8768 */
8769 interface AnnounceRoadRegulation {
8770 'type': 'Navigation.Assistance.AnnounceRoadRegulation';
8771 }
8772}
8773export declare namespace interfaces.playbackcontroller {
8774 /**
8775 *
8776 * @interface
8777 */
8778 interface NextCommandIssuedRequest {
8779 'type': 'PlaybackController.NextCommandIssued';
8780 /**
8781 * Represents the unique identifier for the specific request.
8782 */
8783 'requestId': string;
8784 /**
8785 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8786 */
8787 'timestamp': string;
8788 /**
8789 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8790 */
8791 'locale'?: string;
8792 }
8793}
8794export declare namespace interfaces.playbackcontroller {
8795 /**
8796 *
8797 * @interface
8798 */
8799 interface PauseCommandIssuedRequest {
8800 'type': 'PlaybackController.PauseCommandIssued';
8801 /**
8802 * Represents the unique identifier for the specific request.
8803 */
8804 'requestId': string;
8805 /**
8806 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8807 */
8808 'timestamp': string;
8809 /**
8810 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8811 */
8812 'locale'?: string;
8813 }
8814}
8815export declare namespace interfaces.playbackcontroller {
8816 /**
8817 *
8818 * @interface
8819 */
8820 interface PlayCommandIssuedRequest {
8821 'type': 'PlaybackController.PlayCommandIssued';
8822 /**
8823 * Represents the unique identifier for the specific request.
8824 */
8825 'requestId': string;
8826 /**
8827 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8828 */
8829 'timestamp': string;
8830 /**
8831 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8832 */
8833 'locale'?: string;
8834 }
8835}
8836export declare namespace interfaces.playbackcontroller {
8837 /**
8838 *
8839 * @interface
8840 */
8841 interface PreviousCommandIssuedRequest {
8842 'type': 'PlaybackController.PreviousCommandIssued';
8843 /**
8844 * Represents the unique identifier for the specific request.
8845 */
8846 'requestId': string;
8847 /**
8848 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8849 */
8850 'timestamp': string;
8851 /**
8852 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8853 */
8854 'locale'?: string;
8855 }
8856}
8857export declare namespace interfaces.system {
8858 /**
8859 *
8860 * @interface
8861 */
8862 interface ExceptionEncounteredRequest {
8863 'type': 'System.ExceptionEncountered';
8864 /**
8865 * Represents the unique identifier for the specific request.
8866 */
8867 'requestId': string;
8868 /**
8869 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
8870 */
8871 'timestamp': string;
8872 /**
8873 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
8874 */
8875 'locale'?: string;
8876 'error': interfaces.system.Error;
8877 'cause': interfaces.system.ErrorCause;
8878 }
8879}
8880export declare namespace interfaces.tasks {
8881 /**
8882 * This is the directive that a skill can send as part of their response to a session based request. The response will contain the result of the task that the skill is launched for.
8883 * @interface
8884 */
8885 interface CompleteTaskDirective {
8886 'type': 'Tasks.CompleteTask';
8887 'status': Status;
8888 /**
8889 * This is an object sent to the requester.
8890 */
8891 'result'?: {
8892 [key: string]: any;
8893 };
8894 }
8895}
8896export declare namespace interfaces.videoapp {
8897 /**
8898 *
8899 * @interface
8900 */
8901 interface LaunchDirective {
8902 'type': 'VideoApp.Launch';
8903 'videoItem': interfaces.videoapp.VideoItem;
8904 }
8905}
8906export declare namespace interfaces.viewport {
8907 /**
8908 * This object contains the characteristics related to the text device's viewport.
8909 * @interface
8910 */
8911 interface APLTViewportState {
8912 'type': 'APLT';
8913 /**
8914 * unique identifier of a viewport object
8915 */
8916 'id'?: string;
8917 /**
8918 * List of profiles that device can emulate.
8919 */
8920 'supportedProfiles': Array<interfaces.viewport.aplt.ViewportProfile>;
8921 /**
8922 * horizontal dimension of text display in number of characters
8923 */
8924 'lineLength': number;
8925 /**
8926 * vertical dimension of text display in number of rows
8927 */
8928 'lineCount': number;
8929 'characterFormat': interfaces.viewport.aplt.CharacterFormat;
8930 /**
8931 * list of inter-segment objects
8932 */
8933 'interSegments'?: Array<interfaces.viewport.aplt.InterSegment>;
8934 }
8935}
8936export declare namespace interfaces.viewport {
8937 /**
8938 * This object contains the characteristics related to the APL device's viewport.
8939 * @interface
8940 */
8941 interface APLViewportState {
8942 'type': 'APL';
8943 /**
8944 * unique identifier of a viewport object
8945 */
8946 'id'?: string;
8947 'shape': interfaces.viewport.Shape;
8948 /**
8949 * The pixel density of the viewport.
8950 */
8951 'dpi': number;
8952 'presentationType': interfaces.viewport.PresentationType;
8953 /**
8954 * Indicates if the viewport can be rotated through 90 degrees.
8955 */
8956 'canRotate': boolean;
8957 'configuration': interfaces.viewport.apl.ViewportConfiguration;
8958 }
8959}
8960export declare namespace interfaces.viewport.size {
8961 /**
8962 * Defines range of size with minimum and maximum values for with and height.
8963 * @interface
8964 */
8965 interface ContinuousViewportSize {
8966 'type': 'CONTINUOUS';
8967 'minPixelWidth': number;
8968 'minPixelHeight': number;
8969 'maxPixelWidth': number;
8970 'maxPixelHeight': number;
8971 }
8972}
8973export declare namespace interfaces.viewport.size {
8974 /**
8975 * Defines a fixed size of viewport.
8976 * @interface
8977 */
8978 interface DiscreteViewportSize {
8979 'type': 'DISCRETE';
8980 'pixelWidth': number;
8981 'pixelHeight': number;
8982 }
8983}
8984export declare namespace services.datastore.v1 {
8985 /**
8986 * Remove all existing data in skill's DataStore.
8987 * @interface
8988 */
8989 interface ClearCommand {
8990 'type': 'CLEAR';
8991 }
8992}
8993export declare namespace services.datastore.v1 {
8994 /**
8995 *
8996 * @interface
8997 */
8998 interface Devices {
8999 'type': 'DEVICES';
9000 /**
9001 * Unordered array of device identifiers.
9002 */
9003 'items': Array<string>;
9004 }
9005}
9006export declare namespace services.datastore.v1 {
9007 /**
9008 * Creates a new namespace. If the namespace already exists, the command succeeds without any change.
9009 * @interface
9010 */
9011 interface PutNamespaceCommand {
9012 'type': 'PUT_NAMESPACE';
9013 /**
9014 * Namespace where object needs to be created. Its unique identifier within skill's DataStore.
9015 */
9016 'namespace': string;
9017 }
9018}
9019export declare namespace services.datastore.v1 {
9020 /**
9021 * Creates or updates an object.
9022 * @interface
9023 */
9024 interface PutObjectCommand {
9025 'type': 'PUT_OBJECT';
9026 /**
9027 * Namespace where object needs to be created. Its unique identifier within skill's DataStore.
9028 */
9029 'namespace': string;
9030 /**
9031 * Unique identifier of the objects. Needs to be unique only within client's namespace not globally unique.
9032 */
9033 'key': string;
9034 /**
9035 * Open content payload that is not inspected by the DataStore.
9036 */
9037 'content': any;
9038 }
9039}
9040export declare namespace services.datastore.v1 {
9041 /**
9042 * Deletes an existing namespace. If the namespace doesn't exist, this command succeeds without any change.
9043 * @interface
9044 */
9045 interface RemoveNamespaceCommand {
9046 'type': 'REMOVE_NAMESPACE';
9047 /**
9048 * Namespace which needs to be removed. It's unique identifier within skill's DataStore.
9049 */
9050 'namespace': string;
9051 }
9052}
9053export declare namespace services.datastore.v1 {
9054 /**
9055 * Deletes an existing object. If the object doesn't exist, this command succeeds without any change.
9056 * @interface
9057 */
9058 interface RemoveObjectCommand {
9059 'type': 'REMOVE_OBJECT';
9060 /**
9061 * Namespace where the object is stored. Its unique identifier within skill's DataStore.
9062 */
9063 'namespace': string;
9064 /**
9065 * Unique identifier of the objects. Needs to be unique only within client's namespace not globally unique.
9066 */
9067 'key': string;
9068 }
9069}
9070export declare namespace services.datastore.v1 {
9071 /**
9072 *
9073 * @interface
9074 */
9075 interface User {
9076 'type': 'USER';
9077 /**
9078 * User ID in request envelope (context.System.user.userId).
9079 */
9080 'id': string;
9081 }
9082}
9083export declare namespace services.directive {
9084 /**
9085 *
9086 * @interface
9087 */
9088 interface SpeakDirective {
9089 'type': 'VoicePlayer.Speak';
9090 'speech'?: string;
9091 }
9092}
9093export declare namespace services.gameEngine {
9094 /**
9095 * The deviation recognizer returns true when another specified recognizer reports that the player has deviated from its expected pattern.
9096 * @interface
9097 */
9098 interface DeviationRecognizer {
9099 'type': 'deviation';
9100 /**
9101 * The name of the recognizer that defines a pattern that must not be deviated from.
9102 */
9103 'recognizer'?: string;
9104 }
9105}
9106export declare namespace services.gameEngine {
9107 /**
9108 * This recognizer is true when all of the specified events have occurred in the specified order.
9109 * @interface
9110 */
9111 interface PatternRecognizer {
9112 'type': 'match';
9113 'anchor'?: services.gameEngine.PatternRecognizerAnchorType;
9114 /**
9115 * When true, the recognizer will ignore additional events that occur between the events specified in the pattern.
9116 */
9117 'fuzzy'?: boolean;
9118 /**
9119 * The gadget IDs of the Echo Buttons to consider in this pattern recognizer.
9120 */
9121 'gadgetIds'?: Array<string>;
9122 /**
9123 * The actions to consider in this pattern recognizer. All other actions will be ignored.
9124 */
9125 'actions'?: Array<string>;
9126 /**
9127 * An object that provides all of the events that need to occur, in a specific order, for this recognizer to be true. Omitting any parameters in this object means \"match anything\".
9128 */
9129 'pattern'?: Array<services.gameEngine.Pattern>;
9130 }
9131}
9132export declare namespace services.gameEngine {
9133 /**
9134 * This recognizer consults another recognizer for the degree of completion, and is true if that degree is above the specified threshold. The completion parameter is specified as a decimal percentage.
9135 * @interface
9136 */
9137 interface ProgressRecognizer {
9138 'type': 'progress';
9139 /**
9140 * The name of a recognizer for which to track the progress.
9141 */
9142 'recognizer'?: string;
9143 /**
9144 * The completion threshold, as a decimal percentage, of the specified recognizer before which this recognizer becomes true.
9145 */
9146 'completion'?: number;
9147 }
9148}
9149export declare namespace services.listManagement {
9150 /**
9151 *
9152 * @interface
9153 */
9154 interface ListCreatedEventRequest {
9155 'type': 'AlexaHouseholdListEvent.ListCreated';
9156 /**
9157 * Represents the unique identifier for the specific request.
9158 */
9159 'requestId': string;
9160 /**
9161 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9162 */
9163 'timestamp': string;
9164 /**
9165 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9166 */
9167 'locale'?: string;
9168 'body'?: services.listManagement.ListBody;
9169 'eventCreationTime'?: string;
9170 'eventPublishingTime'?: string;
9171 }
9172}
9173export declare namespace services.listManagement {
9174 /**
9175 *
9176 * @interface
9177 */
9178 interface ListDeletedEventRequest {
9179 'type': 'AlexaHouseholdListEvent.ListDeleted';
9180 /**
9181 * Represents the unique identifier for the specific request.
9182 */
9183 'requestId': string;
9184 /**
9185 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9186 */
9187 'timestamp': string;
9188 /**
9189 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9190 */
9191 'locale'?: string;
9192 'body'?: services.listManagement.ListBody;
9193 'eventCreationTime'?: string;
9194 'eventPublishingTime'?: string;
9195 }
9196}
9197export declare namespace services.listManagement {
9198 /**
9199 *
9200 * @interface
9201 */
9202 interface ListItemsCreatedEventRequest {
9203 'type': 'AlexaHouseholdListEvent.ItemsCreated';
9204 /**
9205 * Represents the unique identifier for the specific request.
9206 */
9207 'requestId': string;
9208 /**
9209 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9210 */
9211 'timestamp': string;
9212 /**
9213 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9214 */
9215 'locale'?: string;
9216 'body'?: services.listManagement.ListItemBody;
9217 'eventCreationTime'?: string;
9218 'eventPublishingTime'?: string;
9219 }
9220}
9221export declare namespace services.listManagement {
9222 /**
9223 *
9224 * @interface
9225 */
9226 interface ListItemsDeletedEventRequest {
9227 'type': 'AlexaHouseholdListEvent.ItemsDeleted';
9228 /**
9229 * Represents the unique identifier for the specific request.
9230 */
9231 'requestId': string;
9232 /**
9233 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9234 */
9235 'timestamp': string;
9236 /**
9237 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9238 */
9239 'locale'?: string;
9240 'body'?: services.listManagement.ListItemBody;
9241 'eventCreationTime'?: string;
9242 'eventPublishingTime'?: string;
9243 }
9244}
9245export declare namespace services.listManagement {
9246 /**
9247 *
9248 * @interface
9249 */
9250 interface ListItemsUpdatedEventRequest {
9251 'type': 'AlexaHouseholdListEvent.ItemsUpdated';
9252 /**
9253 * Represents the unique identifier for the specific request.
9254 */
9255 'requestId': string;
9256 /**
9257 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9258 */
9259 'timestamp': string;
9260 /**
9261 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9262 */
9263 'locale'?: string;
9264 'body'?: services.listManagement.ListItemBody;
9265 'eventCreationTime'?: string;
9266 'eventPublishingTime'?: string;
9267 }
9268}
9269export declare namespace services.listManagement {
9270 /**
9271 *
9272 * @interface
9273 */
9274 interface ListUpdatedEventRequest {
9275 'type': 'AlexaHouseholdListEvent.ListUpdated';
9276 /**
9277 * Represents the unique identifier for the specific request.
9278 */
9279 'requestId': string;
9280 /**
9281 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9282 */
9283 'timestamp': string;
9284 /**
9285 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9286 */
9287 'locale'?: string;
9288 'body'?: services.listManagement.ListBody;
9289 'eventCreationTime'?: string;
9290 'eventPublishingTime'?: string;
9291 }
9292}
9293export declare namespace services.reminderManagement {
9294 /**
9295 * Response object for get reminder request
9296 * @interface
9297 */
9298 interface GetReminderResponse {
9299 /**
9300 * Unique id of this reminder alert
9301 */
9302 'alertToken'?: string;
9303 /**
9304 * Valid ISO 8601 format - Creation time of this reminder alert
9305 */
9306 'createdTime'?: string;
9307 /**
9308 * Valid ISO 8601 format - Last updated time of this reminder alert
9309 */
9310 'updatedTime'?: string;
9311 'status'?: services.reminderManagement.Status;
9312 'trigger'?: services.reminderManagement.Trigger;
9313 'alertInfo'?: services.reminderManagement.AlertInfo;
9314 'pushNotification'?: services.reminderManagement.PushNotification;
9315 /**
9316 * Version of reminder alert
9317 */
9318 'version'?: string;
9319 }
9320}
9321export declare namespace services.reminderManagement {
9322 /**
9323 *
9324 * @interface
9325 */
9326 interface ReminderCreatedEventRequest {
9327 'type': 'Reminders.ReminderCreated';
9328 /**
9329 * Represents the unique identifier for the specific request.
9330 */
9331 'requestId': string;
9332 /**
9333 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9334 */
9335 'timestamp': string;
9336 /**
9337 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9338 */
9339 'locale'?: string;
9340 'body'?: services.reminderManagement.Event;
9341 }
9342}
9343export declare namespace services.reminderManagement {
9344 /**
9345 *
9346 * @interface
9347 */
9348 interface ReminderDeletedEventRequest {
9349 'type': 'Reminders.ReminderDeleted';
9350 /**
9351 * Represents the unique identifier for the specific request.
9352 */
9353 'requestId': string;
9354 /**
9355 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9356 */
9357 'timestamp': string;
9358 /**
9359 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9360 */
9361 'locale'?: string;
9362 'body'?: services.reminderManagement.ReminderDeletedEvent;
9363 }
9364}
9365export declare namespace services.reminderManagement {
9366 /**
9367 *
9368 * @interface
9369 */
9370 interface ReminderStartedEventRequest {
9371 'type': 'Reminders.ReminderStarted';
9372 /**
9373 * Represents the unique identifier for the specific request.
9374 */
9375 'requestId': string;
9376 /**
9377 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9378 */
9379 'timestamp': string;
9380 /**
9381 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9382 */
9383 'locale'?: string;
9384 'body'?: services.reminderManagement.Event;
9385 }
9386}
9387export declare namespace services.reminderManagement {
9388 /**
9389 *
9390 * @interface
9391 */
9392 interface ReminderStatusChangedEventRequest {
9393 'type': 'Reminders.ReminderStatusChanged';
9394 /**
9395 * Represents the unique identifier for the specific request.
9396 */
9397 'requestId': string;
9398 /**
9399 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9400 */
9401 'timestamp': string;
9402 /**
9403 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9404 */
9405 'locale'?: string;
9406 'body'?: services.reminderManagement.Event;
9407 }
9408}
9409export declare namespace services.reminderManagement {
9410 /**
9411 *
9412 * @interface
9413 */
9414 interface ReminderUpdatedEventRequest {
9415 'type': 'Reminders.ReminderUpdated';
9416 /**
9417 * Represents the unique identifier for the specific request.
9418 */
9419 'requestId': string;
9420 /**
9421 * Provides the date and time when Alexa sent the request as an ISO 8601 formatted string. Used to verify the request when hosting your skill as a web service.
9422 */
9423 'timestamp': string;
9424 /**
9425 * A string indicating the user’s locale. For example: en-US. This value is only provided with certain request types.
9426 */
9427 'locale'?: string;
9428 'body'?: services.reminderManagement.Event;
9429 }
9430}
9431export declare namespace services.timerManagement {
9432 /**
9433 * ANNOUNCE trigger behavior represents announcing a certain text that the developer wants to be read out at the expiration of the timer.
9434 * @interface
9435 */
9436 interface AnnounceOperation {
9437 'type': 'ANNOUNCE';
9438 'textToAnnounce': Array<services.timerManagement.TextToAnnounce>;
9439 }
9440}
9441export declare namespace services.timerManagement {
9442 /**
9443 * LAUNCH_TASK trigger behavior representing launch a Skill Connection task exposed by the same skill.
9444 * @interface
9445 */
9446 interface LaunchTaskOperation {
9447 'type': 'LAUNCH_TASK';
9448 'textToConfirm': Array<services.timerManagement.TextToConfirm>;
9449 'task': services.timerManagement.Task;
9450 }
9451}
9452export declare namespace services.timerManagement {
9453 /**
9454 * NOTIFY_ONLY trigger behavior represents chime only when timer expired.
9455 * @interface
9456 */
9457 interface NotifyOnlyOperation {
9458 'type': 'NOTIFY_ONLY';
9459 }
9460}
9461export declare namespace ui {
9462 /**
9463 *
9464 * @interface
9465 */
9466 interface AskForPermissionsConsentCard {
9467 'type': 'AskForPermissionsConsent';
9468 'permissions': Array<string>;
9469 }
9470}
9471export declare namespace ui {
9472 /**
9473 *
9474 * @interface
9475 */
9476 interface LinkAccountCard {
9477 'type': 'LinkAccount';
9478 }
9479}
9480export declare namespace ui {
9481 /**
9482 *
9483 * @interface
9484 */
9485 interface PlainTextOutputSpeech {
9486 'type': 'PlainText';
9487 'playBehavior'?: ui.PlayBehavior;
9488 'text': string;
9489 }
9490}
9491export declare namespace ui {
9492 /**
9493 *
9494 * @interface
9495 */
9496 interface SimpleCard {
9497 'type': 'Simple';
9498 'title'?: string;
9499 'content'?: string;
9500 }
9501}
9502export declare namespace ui {
9503 /**
9504 *
9505 * @interface
9506 */
9507 interface SsmlOutputSpeech {
9508 'type': 'SSML';
9509 'playBehavior'?: ui.PlayBehavior;
9510 'ssml': string;
9511 }
9512}
9513export declare namespace ui {
9514 /**
9515 *
9516 * @interface
9517 */
9518 interface StandardCard {
9519 'type': 'Standard';
9520 'title'?: string;
9521 'text'?: string;
9522 'image'?: ui.Image;
9523 }
9524}
9525export declare namespace services.datastore {
9526 /**
9527 *
9528 */
9529 class DatastoreServiceClient extends BaseServiceClient {
9530 private lwaServiceClient;
9531 private userAgent;
9532 constructor(apiConfiguration: ApiConfiguration, authenticationConfiguration: AuthenticationConfiguration, customUserAgent?: string);
9533 /**
9534 * Send DataStore commands to Alexa device.
9535 * @param {services.datastore.v1.CommandsRequest} commandsRequest
9536 */
9537 callCommandsV1(commandsRequest: services.datastore.v1.CommandsRequest): Promise<ApiResponse>;
9538 /**
9539 * Send DataStore commands to Alexa device.
9540 * @param {services.datastore.v1.CommandsRequest} commandsRequest
9541 */
9542 commandsV1(commandsRequest: services.datastore.v1.CommandsRequest): Promise<services.datastore.v1.CommandsResponse>;
9543 /**
9544 * Cancel pending DataStore commands.
9545 * @param {string} queuedResultId A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE).
9546 */
9547 callCancelCommandsV1(queuedResultId: string): Promise<ApiResponse>;
9548 /**
9549 * Cancel pending DataStore commands.
9550 * @param {string} queuedResultId A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE).
9551 */
9552 cancelCommandsV1(queuedResultId: string): Promise<void>;
9553 /**
9554 * Query statuses of deliveries to offline devices returned by commands API.
9555 * @param {string} queuedResultId A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE).
9556 * @param {number} maxResults Maximum number of CommandsDispatchResult items to return.
9557 * @param {string} nextToken The value of nextToken in the response to fetch next page. If not specified, the request fetches result for the first page.
9558 */
9559 callQueuedResultV1(queuedResultId: string, maxResults?: number, nextToken?: string): Promise<ApiResponse>;
9560 /**
9561 * Query statuses of deliveries to offline devices returned by commands API.
9562 * @param {string} queuedResultId A unique identifier to query result for queued delivery for offline devices (DEVICE_UNAVAILABLE).
9563 * @param {number} maxResults Maximum number of CommandsDispatchResult items to return.
9564 * @param {string} nextToken The value of nextToken in the response to fetch next page. If not specified, the request fetches result for the first page.
9565 */
9566 queuedResultV1(queuedResultId: string, maxResults?: number, nextToken?: string): Promise<services.datastore.v1.QueuedResultResponse>;
9567 }
9568}
9569export declare namespace services.deviceAddress {
9570 /**
9571 *
9572 */
9573 class DeviceAddressServiceClient extends BaseServiceClient {
9574 private userAgent;
9575 constructor(apiConfiguration: ApiConfiguration, customUserAgent?: string);
9576 /**
9577 * Gets the country and postal code of a device
9578 * @param {string} deviceId The device Id for which to get the country and postal code
9579 */
9580 callGetCountryAndPostalCode(deviceId: string): Promise<ApiResponse>;
9581 /**
9582 * Gets the country and postal code of a device
9583 * @param {string} deviceId The device Id for which to get the country and postal code
9584 */
9585 getCountryAndPostalCode(deviceId: string): Promise<services.deviceAddress.ShortAddress>;
9586 /**
9587 * Gets the address of a device
9588 * @param {string} deviceId The device Id for which to get the address
9589 */
9590 callGetFullAddress(deviceId: string): Promise<ApiResponse>;
9591 /**
9592 * Gets the address of a device
9593 * @param {string} deviceId The device Id for which to get the address
9594 */
9595 getFullAddress(deviceId: string): Promise<services.deviceAddress.Address>;
9596 }
9597}
9598export declare namespace services.directive {
9599 /**
9600 *
9601 */
9602 class DirectiveServiceClient extends BaseServiceClient {
9603 private userAgent;
9604 constructor(apiConfiguration: ApiConfiguration, customUserAgent?: string);
9605 /**
9606 * Send directives to Alexa.
9607 * @param {services.directive.SendDirectiveRequest} sendDirectiveRequest Represents the request object to send in the payload.
9608 */
9609 callEnqueue(sendDirectiveRequest: services.directive.SendDirectiveRequest): Promise<ApiResponse>;
9610 /**
9611 * Send directives to Alexa.
9612 * @param {services.directive.SendDirectiveRequest} sendDirectiveRequest Represents the request object to send in the payload.
9613 */
9614 enqueue(sendDirectiveRequest: services.directive.SendDirectiveRequest): Promise<void>;
9615 }
9616}
9617export declare namespace services.endpointEnumeration {
9618 /**
9619 *
9620 */
9621 class EndpointEnumerationServiceClient extends BaseServiceClient {
9622 private userAgent;
9623 constructor(apiConfiguration: ApiConfiguration, customUserAgent?: string);
9624 /**
9625 * This API is invoked by the skill to retrieve endpoints connected to the Echo device.
9626 */
9627 callGetEndpoints(): Promise<ApiResponse>;
9628 /**
9629 * This API is invoked by the skill to retrieve endpoints connected to the Echo device.
9630 */
9631 getEndpoints(): Promise<services.endpointEnumeration.EndpointEnumerationResponse>;
9632 }
9633}
9634export declare namespace services.listManagement {
9635 /**
9636 *
9637 */
9638 class ListManagementServiceClient extends BaseServiceClient {
9639 private userAgent;
9640 constructor(apiConfiguration: ApiConfiguration, customUserAgent?: string);
9641 /**
9642 * Retrieves the metadata for all customer lists, including the customer’s default lists.
9643 */
9644 callGetListsMetadata(): Promise<ApiResponse>;
9645 /**
9646 * Retrieves the metadata for all customer lists, including the customer’s default lists.
9647 */
9648 getListsMetadata(): Promise<services.listManagement.AlexaListsMetadata>;
9649 /**
9650 * This API deletes a customer custom list.
9651 * @param {string} listId Value of the customer’s listId retrieved from a getListsMetadata call
9652 */
9653 callDeleteList(listId: string): Promise<ApiResponse>;
9654 /**
9655 * This API deletes a customer custom list.
9656 * @param {string} listId Value of the customer’s listId retrieved from a getListsMetadata call
9657 */
9658 deleteList(listId: string): Promise<void>;
9659 /**
9660 * This API deletes an item in the specified list.
9661 * @param {string} listId The customer’s listId is retrieved from a getListsMetadata call.
9662 * @param {string} itemId The customer’s itemId is retrieved from a GetList call.
9663 */
9664 callDeleteListItem(listId: string, itemId: string): Promise<ApiResponse>;
9665 /**
9666 * This API deletes an item in the specified list.
9667 * @param {string} listId The customer’s listId is retrieved from a getListsMetadata call.
9668 * @param {string} itemId The customer’s itemId is retrieved from a GetList call.
9669 */
9670 deleteListItem(listId: string, itemId: string): Promise<void>;
9671 /**
9672 * This API can be used to retrieve single item with in any list by listId and itemId. This API can read list items from an archived list. Attempting to read list items from a deleted list return an ObjectNotFound 404 error.
9673 * @param {string} listId Retrieved from a call to getListsMetadata
9674 * @param {string} itemId itemId within a list is retrieved from a getList call
9675 */
9676 callGetListItem(listId: string, itemId: string): Promise<ApiResponse>;
9677 /**
9678 * This API can be used to retrieve single item with in any list by listId and itemId. This API can read list items from an archived list. Attempting to read list items from a deleted list return an ObjectNotFound 404 error.
9679 * @param {string} listId Retrieved from a call to getListsMetadata
9680 * @param {string} itemId itemId within a list is retrieved from a getList call
9681 */
9682 getListItem(listId: string, itemId: string): Promise<services.listManagement.AlexaListItem>;
9683 /**
9684 * API used to update an item value or item status.
9685 * @param {string} listId Customer’s listId
9686 * @param {string} itemId itemId to be updated in the list
9687 * @param {services.listManagement.UpdateListItemRequest} updateListItemRequest
9688 */
9689 callUpdateListItem(listId: string, itemId: string, updateListItemRequest: services.listManagement.UpdateListItemRequest): Promise<ApiResponse>;
9690 /**
9691 * API used to update an item value or item status.
9692 * @param {string} listId Customer’s listId
9693 * @param {string} itemId itemId to be updated in the list
9694 * @param {services.listManagement.UpdateListItemRequest} updateListItemRequest
9695 */
9696 updateListItem(listId: string, itemId: string, updateListItemRequest: services.listManagement.UpdateListItemRequest): Promise<services.listManagement.AlexaListItem>;
9697 /**
9698 * This API creates an item in an active list or in a default list.
9699 * @param {string} listId The customer’s listId retrieved from a getListsMetadata call.
9700 * @param {services.listManagement.CreateListItemRequest} createListItemRequest
9701 */
9702 callCreateListItem(listId: string, createListItemRequest: services.listManagement.CreateListItemRequest): Promise<ApiResponse>;
9703 /**
9704 * This API creates an item in an active list or in a default list.
9705 * @param {string} listId The customer’s listId retrieved from a getListsMetadata call.
9706 * @param {services.listManagement.CreateListItemRequest} createListItemRequest
9707 */
9708 createListItem(listId: string, createListItemRequest: services.listManagement.CreateListItemRequest): Promise<services.listManagement.AlexaListItem>;
9709 /**
9710 * This API updates a custom list. Only the list name or state can be updated. An Alexa customer can turn an archived list into an active one.
9711 * @param {string} listId Value of the customer’s listId retrieved from a getListsMetadata call.
9712 * @param {services.listManagement.UpdateListRequest} updateListRequest
9713 */
9714 callUpdateList(listId: string, updateListRequest: services.listManagement.UpdateListRequest): Promise<ApiResponse>;
9715 /**
9716 * This API updates a custom list. Only the list name or state can be updated. An Alexa customer can turn an archived list into an active one.
9717 * @param {string} listId Value of the customer’s listId retrieved from a getListsMetadata call.
9718 * @param {services.listManagement.UpdateListRequest} updateListRequest
9719 */
9720 updateList(listId: string, updateListRequest: services.listManagement.UpdateListRequest): Promise<services.listManagement.AlexaListMetadata>;
9721 /**
9722 * Retrieves the list metadata including the items in the list with requested status.
9723 * @param {string} listId Retrieved from a call to GetListsMetadata to specify the listId in the request path.
9724 * @param {string} status Specify the status of the list.
9725 */
9726 callGetList(listId: string, status: string): Promise<ApiResponse>;
9727 /**
9728 * Retrieves the list metadata including the items in the list with requested status.
9729 * @param {string} listId Retrieved from a call to GetListsMetadata to specify the listId in the request path.
9730 * @param {string} status Specify the status of the list.
9731 */
9732 getList(listId: string, status: string): Promise<services.listManagement.AlexaList>;
9733 /**
9734 * This API creates a custom list. The new list name must be different than any existing list name.
9735 * @param {services.listManagement.CreateListRequest} createListRequest
9736 */
9737 callCreateList(createListRequest: services.listManagement.CreateListRequest): Promise<ApiResponse>;
9738 /**
9739 * This API creates a custom list. The new list name must be different than any existing list name.
9740 * @param {services.listManagement.CreateListRequest} createListRequest
9741 */
9742 createList(createListRequest: services.listManagement.CreateListRequest): Promise<services.listManagement.AlexaListMetadata>;
9743 }
9744}
9745export declare namespace services.monetization {
9746 /**
9747 *
9748 */
9749 class MonetizationServiceClient extends BaseServiceClient {
9750 private userAgent;
9751 constructor(apiConfiguration: ApiConfiguration, customUserAgent?: string);
9752 /**
9753 * Gets In-Skill Products based on user's context for the Skill.
9754 * @param {string} acceptLanguage User&#39;s locale/language in context
9755 * @param {string} purchasable Filter products based on whether they are purchasable by the user or not. * &#39;PURCHASABLE&#39; - Products that are purchasable by the user. * &#39;NOT_PURCHASABLE&#39; - Products that are not purchasable by the user.
9756 * @param {string} entitled Filter products based on whether they are entitled to the user or not. * &#39;ENTITLED&#39; - Products that the user is entitled to. * &#39;NOT_ENTITLED&#39; - Products that the user is not entitled to.
9757 * @param {string} productType Product type. * &#39;SUBSCRIPTION&#39; - Once purchased, customers will own the content for the subscription period. * &#39;ENTITLEMENT&#39; - Once purchased, customers will own the content forever. * &#39;CONSUMABLE&#39; - Once purchased, customers will be entitled to the content until it is consumed. It can also be re-purchased.
9758 * @param {string} nextToken When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element, the value of which can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that In-Skill Products API understands. Token has expiry of 24 hours.
9759 * @param {number} maxResults sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 100 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned because maxResults was exceeded, the response contains isTruncated &#x3D; true.
9760 */
9761 callGetInSkillProducts(acceptLanguage: string, purchasable?: string, entitled?: string, productType?: string, nextToken?: string, maxResults?: number): Promise<ApiResponse>;
9762 /**
9763 * Gets In-Skill Products based on user's context for the Skill.
9764 * @param {string} acceptLanguage User&#39;s locale/language in context
9765 * @param {string} purchasable Filter products based on whether they are purchasable by the user or not. * &#39;PURCHASABLE&#39; - Products that are purchasable by the user. * &#39;NOT_PURCHASABLE&#39; - Products that are not purchasable by the user.
9766 * @param {string} entitled Filter products based on whether they are entitled to the user or not. * &#39;ENTITLED&#39; - Products that the user is entitled to. * &#39;NOT_ENTITLED&#39; - Products that the user is not entitled to.
9767 * @param {string} productType Product type. * &#39;SUBSCRIPTION&#39; - Once purchased, customers will own the content for the subscription period. * &#39;ENTITLEMENT&#39; - Once purchased, customers will own the content forever. * &#39;CONSUMABLE&#39; - Once purchased, customers will be entitled to the content until it is consumed. It can also be re-purchased.
9768 * @param {string} nextToken When response to this API call is truncated (that is, isTruncated response element value is true), the response also includes the nextToken element, the value of which can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that In-Skill Products API understands. Token has expiry of 24 hours.
9769 * @param {number} maxResults sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 100 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned because maxResults was exceeded, the response contains isTruncated &#x3D; true.
9770 */
9771 getInSkillProducts(acceptLanguage: string, purchasable?: string, entitled?: string, productType?: string, nextToken?: string, maxResults?: number): Promise<services.monetization.InSkillProductsResponse>;
9772 /**
9773 * Get In-Skill Product information based on user context for the Skill.
9774 * @param {string} acceptLanguage User&#39;s locale/language in context
9775 * @param {string} productId Product Id.
9776 */
9777 callGetInSkillProduct(acceptLanguage: string, productId: string): Promise<ApiResponse>;
9778 /**
9779 * Get In-Skill Product information based on user context for the Skill.
9780 * @param {string} acceptLanguage User&#39;s locale/language in context
9781 * @param {string} productId Product Id.
9782 */
9783 getInSkillProduct(acceptLanguage: string, productId: string): Promise<services.monetization.InSkillProduct>;
9784 /**
9785 * Returns transactions of all in skill products purchases of the customer
9786 * @param {string} acceptLanguage User&#39;s locale/language in context
9787 * @param {string} productId Product Id.
9788 * @param {string} status Transaction status for in skill product purchases. * &#39;PENDING_APPROVAL_BY_PARENT&#39; - The transaction is pending approval from parent. * &#39;APPROVED_BY_PARENT&#39; - The transaction was approved by parent and fulfilled successfully.. * &#39;DENIED_BY_PARENT&#39; - The transaction was declined by parent and hence not fulfilled. * &#39;EXPIRED_NO_ACTION_BY_PARENT&#39; - The transaction was expired due to no response from parent and hence not fulfilled. * &#39;ERROR&#39; - The transaction was not fullfiled as there was an error while processing the transaction.
9789 * @param {string} fromLastModifiedTime Filter transactions based on last modified time stamp, FROM duration in format (UTC ISO 8601) i.e. yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSS&#39;Z&#39;
9790 * @param {string} toLastModifiedTime Filter transactions based on last modified time stamp, TO duration in format (UTC ISO 8601) i.e. yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSS&#39;Z&#39;
9791 * @param {string} nextToken When response to this API call is truncated, the response also includes the nextToken in metadata, the value of which can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that In-Skill Products API understands. Token has expiry of 24 hours.
9792 * @param {number} maxResults sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 100 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned because maxResults was exceeded, the response contains nextToken which can be used to fetch next set of result.
9793 */
9794 callGetInSkillProductsTransactions(acceptLanguage: string, productId?: string, status?: string, fromLastModifiedTime?: string, toLastModifiedTime?: string, nextToken?: string, maxResults?: number): Promise<ApiResponse>;
9795 /**
9796 * Returns transactions of all in skill products purchases of the customer
9797 * @param {string} acceptLanguage User&#39;s locale/language in context
9798 * @param {string} productId Product Id.
9799 * @param {string} status Transaction status for in skill product purchases. * &#39;PENDING_APPROVAL_BY_PARENT&#39; - The transaction is pending approval from parent. * &#39;APPROVED_BY_PARENT&#39; - The transaction was approved by parent and fulfilled successfully.. * &#39;DENIED_BY_PARENT&#39; - The transaction was declined by parent and hence not fulfilled. * &#39;EXPIRED_NO_ACTION_BY_PARENT&#39; - The transaction was expired due to no response from parent and hence not fulfilled. * &#39;ERROR&#39; - The transaction was not fullfiled as there was an error while processing the transaction.
9800 * @param {string} fromLastModifiedTime Filter transactions based on last modified time stamp, FROM duration in format (UTC ISO 8601) i.e. yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSS&#39;Z&#39;
9801 * @param {string} toLastModifiedTime Filter transactions based on last modified time stamp, TO duration in format (UTC ISO 8601) i.e. yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSS&#39;Z&#39;
9802 * @param {string} nextToken When response to this API call is truncated, the response also includes the nextToken in metadata, the value of which can be used in the next request as the continuation-token to list the next set of objects. The continuation token is an opaque value that In-Skill Products API understands. Token has expiry of 24 hours.
9803 * @param {number} maxResults sets the maximum number of results returned in the response body. If you want to retrieve fewer than upper limit of 100 results, you can add this parameter to your request. maxResults should not exceed the upper limit. The response might contain fewer results than maxResults, but it will never contain more. If there are additional results that satisfy the search criteria, but these results were not returned because maxResults was exceeded, the response contains nextToken which can be used to fetch next set of result.
9804 */
9805 getInSkillProductsTransactions(acceptLanguage: string, productId?: string, status?: string, fromLastModifiedTime?: string, toLastModifiedTime?: string, nextToken?: string, maxResults?: number): Promise<services.monetization.InSkillProductTransactionsResponse>;
9806 /**
9807 * Returns whether or not voice purchasing is enabled for the skill
9808 */
9809 callGetVoicePurchaseSetting(): Promise<ApiResponse>;
9810 /**
9811 * Returns whether or not voice purchasing is enabled for the skill
9812 */
9813 getVoicePurchaseSetting(): Promise<boolean>;
9814 }
9815}
9816export declare namespace services.proactiveEvents {
9817 /**
9818 *
9819 */
9820 class ProactiveEventsServiceClient extends BaseServiceClient {
9821 private lwaServiceClient;
9822 private userAgent;
9823 constructor(apiConfiguration: ApiConfiguration, authenticationConfiguration: AuthenticationConfiguration, customUserAgent?: string);
9824 /**
9825 * Create a new proactive event in live stage.
9826 * @param {services.proactiveEvents.CreateProactiveEventRequest} createProactiveEventRequest Request to create a new proactive event.
9827 */
9828 callCreateProactiveEvent(createProactiveEventRequest: services.proactiveEvents.CreateProactiveEventRequest, stage: services.proactiveEvents.SkillStage): Promise<ApiResponse>;
9829 /**
9830 * Create a new proactive event in live stage.
9831 * @param {services.proactiveEvents.CreateProactiveEventRequest} createProactiveEventRequest Request to create a new proactive event.
9832 */
9833 createProactiveEvent(createProactiveEventRequest: services.proactiveEvents.CreateProactiveEventRequest, stage: services.proactiveEvents.SkillStage): Promise<void>;
9834 }
9835}
9836export declare namespace services.reminderManagement {
9837 /**
9838 *
9839 */
9840 class ReminderManagementServiceClient extends BaseServiceClient {
9841 private userAgent;
9842 constructor(apiConfiguration: ApiConfiguration, customUserAgent?: string);
9843 /**
9844 * This API is invoked by the skill to delete a single reminder.
9845 * @param {string} alertToken
9846 */
9847 callDeleteReminder(alertToken: string): Promise<ApiResponse>;
9848 /**
9849 * This API is invoked by the skill to delete a single reminder.
9850 * @param {string} alertToken
9851 */
9852 deleteReminder(alertToken: string): Promise<void>;
9853 /**
9854 * This API is invoked by the skill to get a single reminder.
9855 * @param {string} alertToken
9856 */
9857 callGetReminder(alertToken: string): Promise<ApiResponse>;
9858 /**
9859 * This API is invoked by the skill to get a single reminder.
9860 * @param {string} alertToken
9861 */
9862 getReminder(alertToken: string): Promise<services.reminderManagement.GetReminderResponse>;
9863 /**
9864 * This API is invoked by the skill to update a reminder.
9865 * @param {string} alertToken
9866 * @param {services.reminderManagement.ReminderRequest} reminderRequest
9867 */
9868 callUpdateReminder(alertToken: string, reminderRequest: services.reminderManagement.ReminderRequest): Promise<ApiResponse>;
9869 /**
9870 * This API is invoked by the skill to update a reminder.
9871 * @param {string} alertToken
9872 * @param {services.reminderManagement.ReminderRequest} reminderRequest
9873 */
9874 updateReminder(alertToken: string, reminderRequest: services.reminderManagement.ReminderRequest): Promise<services.reminderManagement.ReminderResponse>;
9875 /**
9876 * This API is invoked by the skill to get a all reminders created by the caller.
9877 */
9878 callGetReminders(): Promise<ApiResponse>;
9879 /**
9880 * This API is invoked by the skill to get a all reminders created by the caller.
9881 */
9882 getReminders(): Promise<services.reminderManagement.GetRemindersResponse>;
9883 /**
9884 * This API is invoked by the skill to create a new reminder.
9885 * @param {services.reminderManagement.ReminderRequest} reminderRequest
9886 */
9887 callCreateReminder(reminderRequest: services.reminderManagement.ReminderRequest): Promise<ApiResponse>;
9888 /**
9889 * This API is invoked by the skill to create a new reminder.
9890 * @param {services.reminderManagement.ReminderRequest} reminderRequest
9891 */
9892 createReminder(reminderRequest: services.reminderManagement.ReminderRequest): Promise<services.reminderManagement.ReminderResponse>;
9893 }
9894}
9895export declare namespace services.skillMessaging {
9896 /**
9897 *
9898 */
9899 class SkillMessagingServiceClient extends BaseServiceClient {
9900 private lwaServiceClient;
9901 private userAgent;
9902 constructor(apiConfiguration: ApiConfiguration, authenticationConfiguration: AuthenticationConfiguration, customUserAgent?: string);
9903 /**
9904 * Send a message request to a skill for a specified user.
9905 * @param {string} userId The user Id for the specific user to send the message
9906 * @param {services.skillMessaging.SendSkillMessagingRequest} sendSkillMessagingRequest Message Request to be sent to the skill.
9907 */
9908 callSendSkillMessage(userId: string, sendSkillMessagingRequest: services.skillMessaging.SendSkillMessagingRequest): Promise<ApiResponse>;
9909 /**
9910 * Send a message request to a skill for a specified user.
9911 * @param {string} userId The user Id for the specific user to send the message
9912 * @param {services.skillMessaging.SendSkillMessagingRequest} sendSkillMessagingRequest Message Request to be sent to the skill.
9913 */
9914 sendSkillMessage(userId: string, sendSkillMessagingRequest: services.skillMessaging.SendSkillMessagingRequest): Promise<void>;
9915 }
9916}
9917export declare namespace services.timerManagement {
9918 /**
9919 *
9920 */
9921 class TimerManagementServiceClient extends BaseServiceClient {
9922 private userAgent;
9923 constructor(apiConfiguration: ApiConfiguration, customUserAgent?: string);
9924 /**
9925 * Delete all timers created by the skill.
9926 */
9927 callDeleteTimers(): Promise<ApiResponse>;
9928 /**
9929 * Delete all timers created by the skill.
9930 */
9931 deleteTimers(): Promise<void>;
9932 /**
9933 * Get all timers created by the skill.
9934 */
9935 callGetTimers(): Promise<ApiResponse>;
9936 /**
9937 * Get all timers created by the skill.
9938 */
9939 getTimers(): Promise<services.timerManagement.TimersResponse>;
9940 /**
9941 * Delete a timer by ID.
9942 * @param {string} id
9943 */
9944 callDeleteTimer(id: string): Promise<ApiResponse>;
9945 /**
9946 * Delete a timer by ID.
9947 * @param {string} id
9948 */
9949 deleteTimer(id: string): Promise<void>;
9950 /**
9951 * Get timer by ID.
9952 * @param {string} id
9953 */
9954 callGetTimer(id: string): Promise<ApiResponse>;
9955 /**
9956 * Get timer by ID.
9957 * @param {string} id
9958 */
9959 getTimer(id: string): Promise<services.timerManagement.TimerResponse>;
9960 /**
9961 * Pause a timer.
9962 * @param {string} id
9963 */
9964 callPauseTimer(id: string): Promise<ApiResponse>;
9965 /**
9966 * Pause a timer.
9967 * @param {string} id
9968 */
9969 pauseTimer(id: string): Promise<void>;
9970 /**
9971 * Resume a timer.
9972 * @param {string} id
9973 */
9974 callResumeTimer(id: string): Promise<ApiResponse>;
9975 /**
9976 * Resume a timer.
9977 * @param {string} id
9978 */
9979 resumeTimer(id: string): Promise<void>;
9980 /**
9981 * Create a new timer.
9982 * @param {services.timerManagement.TimerRequest} timerRequest
9983 */
9984 callCreateTimer(timerRequest: services.timerManagement.TimerRequest): Promise<ApiResponse>;
9985 /**
9986 * Create a new timer.
9987 * @param {services.timerManagement.TimerRequest} timerRequest
9988 */
9989 createTimer(timerRequest: services.timerManagement.TimerRequest): Promise<services.timerManagement.TimerResponse>;
9990 }
9991}
9992export declare namespace services.ups {
9993 /**
9994 *
9995 */
9996 class UpsServiceClient extends BaseServiceClient {
9997 private userAgent;
9998 constructor(apiConfiguration: ApiConfiguration, customUserAgent?: string);
9999 /**
10000 * Gets the email address of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:email:read]
10001 */
10002 callGetProfileEmail(): Promise<ApiResponse>;
10003 /**
10004 * Gets the email address of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:email:read]
10005 */
10006 getProfileEmail(): Promise<string>;
10007 /**
10008 * Gets the given name (first name) of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:given_name:read]
10009 */
10010 callGetProfileGivenName(): Promise<ApiResponse>;
10011 /**
10012 * Gets the given name (first name) of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:given_name:read]
10013 */
10014 getProfileGivenName(): Promise<string>;
10015 /**
10016 * Gets the mobile phone number of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:mobile_number:read]
10017 */
10018 callGetProfileMobileNumber(): Promise<ApiResponse>;
10019 /**
10020 * Gets the mobile phone number of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:mobile_number:read]
10021 */
10022 getProfileMobileNumber(): Promise<services.ups.PhoneNumber>;
10023 /**
10024 * Gets the full name of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:name:read]
10025 */
10026 callGetProfileName(): Promise<ApiResponse>;
10027 /**
10028 * Gets the full name of the customer associated with the current enablement. Requires customer consent for scopes: [alexa::profile:name:read]
10029 */
10030 getProfileName(): Promise<string>;
10031 /**
10032 * Gets the distance measurement unit of the device. Does not require explict customer consent.
10033 * @param {string} deviceId The device Id
10034 */
10035 callGetSystemDistanceUnits(deviceId: string): Promise<ApiResponse>;
10036 /**
10037 * Gets the distance measurement unit of the device. Does not require explict customer consent.
10038 * @param {string} deviceId The device Id
10039 */
10040 getSystemDistanceUnits(deviceId: string): Promise<services.ups.DistanceUnits>;
10041 /**
10042 * Gets the temperature measurement units of the device. Does not require explict customer consent.
10043 * @param {string} deviceId The device Id
10044 */
10045 callGetSystemTemperatureUnit(deviceId: string): Promise<ApiResponse>;
10046 /**
10047 * Gets the temperature measurement units of the device. Does not require explict customer consent.
10048 * @param {string} deviceId The device Id
10049 */
10050 getSystemTemperatureUnit(deviceId: string): Promise<services.ups.TemperatureUnit>;
10051 /**
10052 * Gets the time zone of the device. Does not require explict customer consent.
10053 * @param {string} deviceId The device Id
10054 */
10055 callGetSystemTimeZone(deviceId: string): Promise<ApiResponse>;
10056 /**
10057 * Gets the time zone of the device. Does not require explict customer consent.
10058 * @param {string} deviceId The device Id
10059 */
10060 getSystemTimeZone(deviceId: string): Promise<string>;
10061 /**
10062 * Gets the given name (first name) of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:given_name:read]
10063 */
10064 callGetPersonsProfileGivenName(): Promise<ApiResponse>;
10065 /**
10066 * Gets the given name (first name) of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:given_name:read]
10067 */
10068 getPersonsProfileGivenName(): Promise<string>;
10069 /**
10070 * Gets the mobile phone number of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:mobile_number:read]
10071 */
10072 callGetPersonsProfileMobileNumber(): Promise<ApiResponse>;
10073 /**
10074 * Gets the mobile phone number of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:mobile_number:read]
10075 */
10076 getPersonsProfileMobileNumber(): Promise<services.ups.PhoneNumber>;
10077 /**
10078 * Gets the full name of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:name:read]
10079 */
10080 callGetPersonsProfileName(): Promise<ApiResponse>;
10081 /**
10082 * Gets the full name of the recognized speaker at person-level. Requires speaker consent at person-level for scopes: [alexa::profile:name:read]
10083 */
10084 getPersonsProfileName(): Promise<string>;
10085 }
10086}
10087export declare namespace services {
10088 /**
10089 * Helper class that instantiates an ServiceClient implementation automatically resolving its
10090 * required ApiConfiguration.
10091 * @export
10092 * @class ServiceClientFactory
10093 */
10094 class ServiceClientFactory {
10095 protected apiConfiguration: ApiConfiguration;
10096 constructor(apiConfiguration: ApiConfiguration);
10097 getDeviceAddressServiceClient(): deviceAddress.DeviceAddressServiceClient;
10098 getDirectiveServiceClient(): directive.DirectiveServiceClient;
10099 getEndpointEnumerationServiceClient(): endpointEnumeration.EndpointEnumerationServiceClient;
10100 getListManagementServiceClient(): listManagement.ListManagementServiceClient;
10101 getMonetizationServiceClient(): monetization.MonetizationServiceClient;
10102 getReminderManagementServiceClient(): reminderManagement.ReminderManagementServiceClient;
10103 getTimerManagementServiceClient(): timerManagement.TimerManagementServiceClient;
10104 getUpsServiceClient(): ups.UpsServiceClient;
10105 }
10106}