pulumi-stripe/file.js

A Pulumi package for creating and managing Stripe resources.

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.File = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * This object represents files hosted on Stripe's servers - [Stripe API file documentation](https://stripe.com/docs/api/files).
 * You can upload files with the create file request (for example, when uploading dispute evidence).
 *
 * Stripe File upload [guide](https://stripe.com/docs/file-upload#uploading-a-file)
 *
 * > Update or removal of the file isn't supported through the Stripe API.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fs from "fs";
 * import * as stripe from "pulumi-stripe";
 *
 * // minimal file field
 * const logoFile = new stripe.File("logoFile", {
 *     filename: "logo.jpg",
 *     purpose: "business_logo",
 *     base64content: fs.readFileSync(`${HOME}/logo.jpg`, { encoding: "base64" }),
 * });
 * // file with file link
 * const logoIndex_fileFile = new stripe.File("logoIndex/fileFile", {
 *     filename: "logo.jpg",
 *     purpose: "business_logo",
 *     base64content: fs.readFileSync(`${HOME}/logo.jpg`, { encoding: "base64" }),
 *     linkData: {
 *         create: true,
 *         expiresAt: 1826659124,
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import stripe:index/file:File file <file_id>
 * ```
 */
class File extends pulumi.CustomResource {
    /**
     * Get an existing File 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, id, state, opts) {
        return new File(name, state, { ...opts, id: id });
    }
    /**
     * Returns true if the given object is an instance of File.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj) {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === File.__pulumiType;
    }
    constructor(name, argsOrState, opts) {
        let resourceInputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState;
            resourceInputs["base64content"] = state?.base64content;
            resourceInputs["created"] = state?.created;
            resourceInputs["expiresAt"] = state?.expiresAt;
            resourceInputs["filename"] = state?.filename;
            resourceInputs["linkData"] = state?.linkData;
            resourceInputs["links"] = state?.links;
            resourceInputs["object"] = state?.object;
            resourceInputs["purpose"] = state?.purpose;
            resourceInputs["size"] = state?.size;
            resourceInputs["type"] = state?.type;
            resourceInputs["url"] = state?.url;
        }
        else {
            const args = argsOrState;
            if (args?.base64content === undefined && !opts.urn) {
                throw new Error("Missing required property 'base64content'");
            }
            if (args?.filename === undefined && !opts.urn) {
                throw new Error("Missing required property 'filename'");
            }
            if (args?.purpose === undefined && !opts.urn) {
                throw new Error("Missing required property 'purpose'");
            }
            resourceInputs["base64content"] = args?.base64content;
            resourceInputs["filename"] = args?.filename;
            resourceInputs["linkData"] = args?.linkData;
            resourceInputs["purpose"] = args?.purpose;
            resourceInputs["created"] = undefined /*out*/;
            resourceInputs["expiresAt"] = undefined /*out*/;
            resourceInputs["links"] = undefined /*out*/;
            resourceInputs["object"] = undefined /*out*/;
            resourceInputs["size"] = undefined /*out*/;
            resourceInputs["type"] = undefined /*out*/;
            resourceInputs["url"] = undefined /*out*/;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(File.__pulumiType, name, resourceInputs, opts);
    }
}
exports.File = File;
/** @internal */
File.__pulumiType = 'stripe:index/file:File';
//# sourceMappingURL=file.js.map