UNPKG

@maienm/pulumi-readarr

Version:

A Pulumi package for creating and managing Readarr resources. Based on terraform-provider-readarr: version v2.1.0

1,131 lines (1,130 loc) 25.1 kB
import * as pulumi from "@pulumi/pulumi"; /** * <!-- subcategory:Notifications -->Notification resource. * For more information refer to [Notification](https://wiki.servarr.com/readarr/settings#connect). * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as readarr from "@maienm/pulumi-readarr"; * * const example = new readarr.notifications.Notification("example", { * configContract: "CustomScriptSettings", * implementation: "CustomScript", * includeHealthWarnings: false, * onAuthorDelete: false, * onBookDelete: false, * onBookFileDelete: false, * onBookFileDeleteForUpgrade: true, * onBookRetag: false, * onDownloadFailure: true, * onGrab: false, * onHealthIssue: false, * onImportFailure: false, * onReleaseImport: false, * onRename: false, * onUpgrade: false, * path: "/scripts/readarr.sh", * }); * ``` * * ## Import * * import using the API/UI ID * * ```sh * $ pulumi import readarr:Notifications/notification:Notification example 1 * ``` */ export declare class Notification extends pulumi.CustomResource { /** * Get an existing Notification resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NotificationState, opts?: pulumi.CustomResourceOptions): Notification; /** * Returns true if the given object is an instance of Notification. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Notification; /** * Access token. */ readonly accessToken: pulumi.Output<string>; /** * Access token secret. */ readonly accessTokenSecret: pulumi.Output<string>; /** * Add IDs. */ readonly addIds: pulumi.Output<string[]>; /** * API key. */ readonly apiKey: pulumi.Output<string>; /** * App token. */ readonly appToken: pulumi.Output<string>; /** * Arguments. */ readonly arguments: pulumi.Output<string>; /** * Attach files flag. */ readonly attachFiles: pulumi.Output<boolean>; /** * Auth user. */ readonly authUser: pulumi.Output<string>; /** * Author. */ readonly author: pulumi.Output<string>; /** * Avatar. */ readonly avatar: pulumi.Output<string>; /** * Bcc. */ readonly bccs: pulumi.Output<string[]>; /** * Bot token. */ readonly botToken: pulumi.Output<string>; /** * Cc. */ readonly ccs: pulumi.Output<string[]>; /** * Channel. */ readonly channel: pulumi.Output<string>; /** * Channel tags. */ readonly channelTags: pulumi.Output<string[]>; /** * Chat ID. */ readonly chatId: pulumi.Output<string>; /** * Click URL. */ readonly clickUrl: pulumi.Output<string>; /** * Condition. `10` BrandNew, `20` LikeNew, `30` VeryGood, `40` Good, `50` Acceptable, `60` Poor. */ readonly condition: pulumi.Output<number>; /** * Notification configuration template. */ readonly configContract: pulumi.Output<string>; /** * Consumer key. */ readonly consumerKey: pulumi.Output<string>; /** * Consumer secret. */ readonly consumerSecret: pulumi.Output<string>; /** * Condition description. */ readonly description: pulumi.Output<string>; /** * Device IDs. */ readonly deviceIds: pulumi.Output<string[]>; /** * Device names. */ readonly deviceNames: pulumi.Output<string>; /** * Devices. */ readonly devices: pulumi.Output<string[]>; /** * Direct message flag. */ readonly directMessage: pulumi.Output<boolean>; /** * Event. */ readonly event: pulumi.Output<string>; /** * Expire. */ readonly expire: pulumi.Output<number>; /** * Devices. */ readonly fieldTags: pulumi.Output<string[]>; /** * From. */ readonly from: pulumi.Output<string>; /** * Grab fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Group, `5` Size, `6` Links, `7` Release, `8` Poster, `9` Fanart, `10` CustomFormats, `11` CustomFormatScore. */ readonly grabFields: pulumi.Output<number>; /** * Host. */ readonly host: pulumi.Output<string>; /** * Icon. */ readonly icon: pulumi.Output<string>; /** * Notification implementation name. */ readonly implementation: pulumi.Output<string>; /** * Import fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Codecs, `5` Group, `6` Size, `7` Languages, `8` Subtitles, `9` Links, `10` Release, `11` Poster, `12` Fanart. */ readonly importFields: pulumi.Output<number>; /** * Include health warnings. */ readonly includeHealthWarnings: pulumi.Output<boolean>; /** * Instance name. */ readonly instanceName: pulumi.Output<string>; /** * Key. */ readonly key: pulumi.Output<string>; /** * Purchase location. */ readonly location: pulumi.Output<string>; /** * Map From. */ readonly mapFrom: pulumi.Output<string>; /** * Map To. */ readonly mapTo: pulumi.Output<string>; /** * Mention. */ readonly mention: pulumi.Output<string>; /** * Method. `1` POST, `2` PUT. */ readonly method: pulumi.Output<number>; /** * Notification name. */ readonly name: pulumi.Output<string>; /** * Notify flag. */ readonly notify: pulumi.Output<boolean>; /** * On application update flag. */ readonly onApplicationUpdate: pulumi.Output<boolean>; /** * On author deleted flag. */ readonly onAuthorDelete: pulumi.Output<boolean>; /** * On book delete flag. */ readonly onBookDelete: pulumi.Output<boolean>; /** * On book file delete flag. */ readonly onBookFileDelete: pulumi.Output<boolean>; /** * On book file delete for upgrade flag. */ readonly onBookFileDeleteForUpgrade: pulumi.Output<boolean>; /** * On book retag flag. */ readonly onBookRetag: pulumi.Output<boolean>; /** * On download failure flag. */ readonly onDownloadFailure: pulumi.Output<boolean>; /** * On grab flag. */ readonly onGrab: pulumi.Output<boolean>; /** * On health issue flag. */ readonly onHealthIssue: pulumi.Output<boolean>; /** * On import failure flag. */ readonly onImportFailure: pulumi.Output<boolean>; /** * On release import flag. */ readonly onReleaseImport: pulumi.Output<boolean>; /** * On rename flag. */ readonly onRename: pulumi.Output<boolean>; /** * On upgrade flag. */ readonly onUpgrade: pulumi.Output<boolean>; /** * password. */ readonly password: pulumi.Output<string>; /** * Path. */ readonly path: pulumi.Output<string>; /** * Port. */ readonly port: pulumi.Output<number>; /** * Priority. */ readonly priority: pulumi.Output<number>; /** * Recipients. */ readonly recipients: pulumi.Output<string[]>; /** * Refresh token. */ readonly refreshToken: pulumi.Output<string>; /** * Remove IDs. */ readonly removeIds: pulumi.Output<string[]>; /** * Request token secret. */ readonly requestTokenSecret: pulumi.Output<string>; /** * Require encryption flag. */ readonly requireEncryption: pulumi.Output<boolean>; /** * Retry. */ readonly retry: pulumi.Output<number>; /** * Add silently flag. */ readonly sendSilently: pulumi.Output<boolean>; /** * Sender domain. */ readonly senderDomain: pulumi.Output<string>; /** * Sender ID. */ readonly senderId: pulumi.Output<string>; /** * server. */ readonly server: pulumi.Output<string>; /** * Server url. */ readonly serverUrl: pulumi.Output<string>; /** * Sign in. */ readonly signIn: pulumi.Output<string>; /** * Sound. */ readonly sound: pulumi.Output<string>; /** * List of associated tags. */ readonly tags: pulumi.Output<number[]>; /** * Token. */ readonly token: pulumi.Output<string>; /** * Devices. */ readonly topics: pulumi.Output<string[]>; /** * To. */ readonly tos: pulumi.Output<string[]>; /** * Update library flag. */ readonly updateLibrary: pulumi.Output<boolean>; /** * URL. */ readonly url: pulumi.Output<string>; /** * URL base. */ readonly urlBase: pulumi.Output<string>; /** * Use EU endpoint flag. */ readonly useEuEndpoint: pulumi.Output<boolean>; /** * Use SSL flag. */ readonly useSsl: pulumi.Output<boolean>; /** * User ID. */ readonly userId: pulumi.Output<string>; /** * User key. */ readonly userKey: pulumi.Output<string>; /** * Username. */ readonly username: pulumi.Output<string>; /** * Web hook url. */ readonly webHookUrl: pulumi.Output<string>; /** * Create a Notification resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: NotificationArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Notification resources. */ export interface NotificationState { /** * Access token. */ accessToken?: pulumi.Input<string>; /** * Access token secret. */ accessTokenSecret?: pulumi.Input<string>; /** * Add IDs. */ addIds?: pulumi.Input<pulumi.Input<string>[]>; /** * API key. */ apiKey?: pulumi.Input<string>; /** * App token. */ appToken?: pulumi.Input<string>; /** * Arguments. */ arguments?: pulumi.Input<string>; /** * Attach files flag. */ attachFiles?: pulumi.Input<boolean>; /** * Auth user. */ authUser?: pulumi.Input<string>; /** * Author. */ author?: pulumi.Input<string>; /** * Avatar. */ avatar?: pulumi.Input<string>; /** * Bcc. */ bccs?: pulumi.Input<pulumi.Input<string>[]>; /** * Bot token. */ botToken?: pulumi.Input<string>; /** * Cc. */ ccs?: pulumi.Input<pulumi.Input<string>[]>; /** * Channel. */ channel?: pulumi.Input<string>; /** * Channel tags. */ channelTags?: pulumi.Input<pulumi.Input<string>[]>; /** * Chat ID. */ chatId?: pulumi.Input<string>; /** * Click URL. */ clickUrl?: pulumi.Input<string>; /** * Condition. `10` BrandNew, `20` LikeNew, `30` VeryGood, `40` Good, `50` Acceptable, `60` Poor. */ condition?: pulumi.Input<number>; /** * Notification configuration template. */ configContract?: pulumi.Input<string>; /** * Consumer key. */ consumerKey?: pulumi.Input<string>; /** * Consumer secret. */ consumerSecret?: pulumi.Input<string>; /** * Condition description. */ description?: pulumi.Input<string>; /** * Device IDs. */ deviceIds?: pulumi.Input<pulumi.Input<string>[]>; /** * Device names. */ deviceNames?: pulumi.Input<string>; /** * Devices. */ devices?: pulumi.Input<pulumi.Input<string>[]>; /** * Direct message flag. */ directMessage?: pulumi.Input<boolean>; /** * Event. */ event?: pulumi.Input<string>; /** * Expire. */ expire?: pulumi.Input<number>; /** * Devices. */ fieldTags?: pulumi.Input<pulumi.Input<string>[]>; /** * From. */ from?: pulumi.Input<string>; /** * Grab fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Group, `5` Size, `6` Links, `7` Release, `8` Poster, `9` Fanart, `10` CustomFormats, `11` CustomFormatScore. */ grabFields?: pulumi.Input<number>; /** * Host. */ host?: pulumi.Input<string>; /** * Icon. */ icon?: pulumi.Input<string>; /** * Notification implementation name. */ implementation?: pulumi.Input<string>; /** * Import fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Codecs, `5` Group, `6` Size, `7` Languages, `8` Subtitles, `9` Links, `10` Release, `11` Poster, `12` Fanart. */ importFields?: pulumi.Input<number>; /** * Include health warnings. */ includeHealthWarnings?: pulumi.Input<boolean>; /** * Instance name. */ instanceName?: pulumi.Input<string>; /** * Key. */ key?: pulumi.Input<string>; /** * Purchase location. */ location?: pulumi.Input<string>; /** * Map From. */ mapFrom?: pulumi.Input<string>; /** * Map To. */ mapTo?: pulumi.Input<string>; /** * Mention. */ mention?: pulumi.Input<string>; /** * Method. `1` POST, `2` PUT. */ method?: pulumi.Input<number>; /** * Notification name. */ name?: pulumi.Input<string>; /** * Notify flag. */ notify?: pulumi.Input<boolean>; /** * On application update flag. */ onApplicationUpdate?: pulumi.Input<boolean>; /** * On author deleted flag. */ onAuthorDelete?: pulumi.Input<boolean>; /** * On book delete flag. */ onBookDelete?: pulumi.Input<boolean>; /** * On book file delete flag. */ onBookFileDelete?: pulumi.Input<boolean>; /** * On book file delete for upgrade flag. */ onBookFileDeleteForUpgrade?: pulumi.Input<boolean>; /** * On book retag flag. */ onBookRetag?: pulumi.Input<boolean>; /** * On download failure flag. */ onDownloadFailure?: pulumi.Input<boolean>; /** * On grab flag. */ onGrab?: pulumi.Input<boolean>; /** * On health issue flag. */ onHealthIssue?: pulumi.Input<boolean>; /** * On import failure flag. */ onImportFailure?: pulumi.Input<boolean>; /** * On release import flag. */ onReleaseImport?: pulumi.Input<boolean>; /** * On rename flag. */ onRename?: pulumi.Input<boolean>; /** * On upgrade flag. */ onUpgrade?: pulumi.Input<boolean>; /** * password. */ password?: pulumi.Input<string>; /** * Path. */ path?: pulumi.Input<string>; /** * Port. */ port?: pulumi.Input<number>; /** * Priority. */ priority?: pulumi.Input<number>; /** * Recipients. */ recipients?: pulumi.Input<pulumi.Input<string>[]>; /** * Refresh token. */ refreshToken?: pulumi.Input<string>; /** * Remove IDs. */ removeIds?: pulumi.Input<pulumi.Input<string>[]>; /** * Request token secret. */ requestTokenSecret?: pulumi.Input<string>; /** * Require encryption flag. */ requireEncryption?: pulumi.Input<boolean>; /** * Retry. */ retry?: pulumi.Input<number>; /** * Add silently flag. */ sendSilently?: pulumi.Input<boolean>; /** * Sender domain. */ senderDomain?: pulumi.Input<string>; /** * Sender ID. */ senderId?: pulumi.Input<string>; /** * server. */ server?: pulumi.Input<string>; /** * Server url. */ serverUrl?: pulumi.Input<string>; /** * Sign in. */ signIn?: pulumi.Input<string>; /** * Sound. */ sound?: pulumi.Input<string>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Token. */ token?: pulumi.Input<string>; /** * Devices. */ topics?: pulumi.Input<pulumi.Input<string>[]>; /** * To. */ tos?: pulumi.Input<pulumi.Input<string>[]>; /** * Update library flag. */ updateLibrary?: pulumi.Input<boolean>; /** * URL. */ url?: pulumi.Input<string>; /** * URL base. */ urlBase?: pulumi.Input<string>; /** * Use EU endpoint flag. */ useEuEndpoint?: pulumi.Input<boolean>; /** * Use SSL flag. */ useSsl?: pulumi.Input<boolean>; /** * User ID. */ userId?: pulumi.Input<string>; /** * User key. */ userKey?: pulumi.Input<string>; /** * Username. */ username?: pulumi.Input<string>; /** * Web hook url. */ webHookUrl?: pulumi.Input<string>; } /** * The set of arguments for constructing a Notification resource. */ export interface NotificationArgs { /** * Access token. */ accessToken?: pulumi.Input<string>; /** * Access token secret. */ accessTokenSecret?: pulumi.Input<string>; /** * Add IDs. */ addIds?: pulumi.Input<pulumi.Input<string>[]>; /** * API key. */ apiKey?: pulumi.Input<string>; /** * App token. */ appToken?: pulumi.Input<string>; /** * Arguments. */ arguments?: pulumi.Input<string>; /** * Attach files flag. */ attachFiles?: pulumi.Input<boolean>; /** * Auth user. */ authUser?: pulumi.Input<string>; /** * Author. */ author?: pulumi.Input<string>; /** * Avatar. */ avatar?: pulumi.Input<string>; /** * Bcc. */ bccs?: pulumi.Input<pulumi.Input<string>[]>; /** * Bot token. */ botToken?: pulumi.Input<string>; /** * Cc. */ ccs?: pulumi.Input<pulumi.Input<string>[]>; /** * Channel. */ channel?: pulumi.Input<string>; /** * Channel tags. */ channelTags?: pulumi.Input<pulumi.Input<string>[]>; /** * Chat ID. */ chatId?: pulumi.Input<string>; /** * Click URL. */ clickUrl?: pulumi.Input<string>; /** * Condition. `10` BrandNew, `20` LikeNew, `30` VeryGood, `40` Good, `50` Acceptable, `60` Poor. */ condition?: pulumi.Input<number>; /** * Notification configuration template. */ configContract: pulumi.Input<string>; /** * Consumer key. */ consumerKey?: pulumi.Input<string>; /** * Consumer secret. */ consumerSecret?: pulumi.Input<string>; /** * Condition description. */ description?: pulumi.Input<string>; /** * Device IDs. */ deviceIds?: pulumi.Input<pulumi.Input<string>[]>; /** * Device names. */ deviceNames?: pulumi.Input<string>; /** * Devices. */ devices?: pulumi.Input<pulumi.Input<string>[]>; /** * Direct message flag. */ directMessage?: pulumi.Input<boolean>; /** * Event. */ event?: pulumi.Input<string>; /** * Expire. */ expire?: pulumi.Input<number>; /** * Devices. */ fieldTags?: pulumi.Input<pulumi.Input<string>[]>; /** * From. */ from?: pulumi.Input<string>; /** * Grab fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Group, `5` Size, `6` Links, `7` Release, `8` Poster, `9` Fanart, `10` CustomFormats, `11` CustomFormatScore. */ grabFields?: pulumi.Input<number>; /** * Host. */ host?: pulumi.Input<string>; /** * Icon. */ icon?: pulumi.Input<string>; /** * Notification implementation name. */ implementation: pulumi.Input<string>; /** * Import fields. `0` Overview, `1` Rating, `2` Genres, `3` Quality, `4` Codecs, `5` Group, `6` Size, `7` Languages, `8` Subtitles, `9` Links, `10` Release, `11` Poster, `12` Fanart. */ importFields?: pulumi.Input<number>; /** * Include health warnings. */ includeHealthWarnings?: pulumi.Input<boolean>; /** * Instance name. */ instanceName?: pulumi.Input<string>; /** * Key. */ key?: pulumi.Input<string>; /** * Purchase location. */ location?: pulumi.Input<string>; /** * Map From. */ mapFrom?: pulumi.Input<string>; /** * Map To. */ mapTo?: pulumi.Input<string>; /** * Mention. */ mention?: pulumi.Input<string>; /** * Method. `1` POST, `2` PUT. */ method?: pulumi.Input<number>; /** * Notification name. */ name?: pulumi.Input<string>; /** * Notify flag. */ notify?: pulumi.Input<boolean>; /** * On application update flag. */ onApplicationUpdate?: pulumi.Input<boolean>; /** * On author deleted flag. */ onAuthorDelete?: pulumi.Input<boolean>; /** * On book delete flag. */ onBookDelete?: pulumi.Input<boolean>; /** * On book file delete flag. */ onBookFileDelete?: pulumi.Input<boolean>; /** * On book file delete for upgrade flag. */ onBookFileDeleteForUpgrade?: pulumi.Input<boolean>; /** * On book retag flag. */ onBookRetag?: pulumi.Input<boolean>; /** * On download failure flag. */ onDownloadFailure?: pulumi.Input<boolean>; /** * On grab flag. */ onGrab?: pulumi.Input<boolean>; /** * On health issue flag. */ onHealthIssue?: pulumi.Input<boolean>; /** * On import failure flag. */ onImportFailure?: pulumi.Input<boolean>; /** * On release import flag. */ onReleaseImport?: pulumi.Input<boolean>; /** * On rename flag. */ onRename?: pulumi.Input<boolean>; /** * On upgrade flag. */ onUpgrade?: pulumi.Input<boolean>; /** * password. */ password?: pulumi.Input<string>; /** * Path. */ path?: pulumi.Input<string>; /** * Port. */ port?: pulumi.Input<number>; /** * Priority. */ priority?: pulumi.Input<number>; /** * Recipients. */ recipients?: pulumi.Input<pulumi.Input<string>[]>; /** * Refresh token. */ refreshToken?: pulumi.Input<string>; /** * Remove IDs. */ removeIds?: pulumi.Input<pulumi.Input<string>[]>; /** * Request token secret. */ requestTokenSecret?: pulumi.Input<string>; /** * Require encryption flag. */ requireEncryption?: pulumi.Input<boolean>; /** * Retry. */ retry?: pulumi.Input<number>; /** * Add silently flag. */ sendSilently?: pulumi.Input<boolean>; /** * Sender domain. */ senderDomain?: pulumi.Input<string>; /** * Sender ID. */ senderId?: pulumi.Input<string>; /** * server. */ server?: pulumi.Input<string>; /** * Server url. */ serverUrl?: pulumi.Input<string>; /** * Sign in. */ signIn?: pulumi.Input<string>; /** * Sound. */ sound?: pulumi.Input<string>; /** * List of associated tags. */ tags?: pulumi.Input<pulumi.Input<number>[]>; /** * Token. */ token?: pulumi.Input<string>; /** * Devices. */ topics?: pulumi.Input<pulumi.Input<string>[]>; /** * To. */ tos?: pulumi.Input<pulumi.Input<string>[]>; /** * Update library flag. */ updateLibrary?: pulumi.Input<boolean>; /** * URL. */ url?: pulumi.Input<string>; /** * URL base. */ urlBase?: pulumi.Input<string>; /** * Use EU endpoint flag. */ useEuEndpoint?: pulumi.Input<boolean>; /** * Use SSL flag. */ useSsl?: pulumi.Input<boolean>; /** * User ID. */ userId?: pulumi.Input<string>; /** * User key. */ userKey?: pulumi.Input<string>; /** * Username. */ username?: pulumi.Input<string>; /** * Web hook url. */ webHookUrl?: pulumi.Input<string>; }