@depup/stripe 21.0.0-depup.0

package/types/FileLinksResource.d.ts

@@ -0,0 +1,114 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface FileLinkCreateParams {
+      /**
+       * The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `financial_account_statement`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
+       */
+      file: string;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * The link isn't usable after this future timestamp.
+       */
+      expires_at?: number;
+
+      /**
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+       */
+      metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+    }
+
+    interface FileLinkRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface FileLinkUpdateParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately.
+       */
+      expires_at?: Stripe.Emptyable<'now' | number>;
+
+      /**
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+       */
+      metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+    }
+
+    interface FileLinkListParams extends PaginationParams {
+      /**
+       * Only return links that were created during the given date interval.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Filter links by their expiration status. By default, Stripe returns all links.
+       */
+      expired?: boolean;
+
+      /**
+       * Only return links for the given file.
+       */
+      file?: string;
+    }
+
+    class FileLinksResource {
+      /**
+       * Creates a new file link object.
+       */
+      create(
+        params: FileLinkCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FileLink>>;
+
+      /**
+       * Retrieves the file link with the given ID.
+       */
+      retrieve(
+        id: string,
+        params?: FileLinkRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FileLink>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FileLink>>;
+
+      /**
+       * Updates an existing file link object. Expired links can no longer be updated.
+       */
+      update(
+        id: string,
+        params?: FileLinkUpdateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.FileLink>>;
+
+      /**
+       * Returns a list of file links.
+       */
+      list(
+        params?: FileLinkListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.FileLink>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.FileLink>;
+    }
+  }
+}

package/types/Files.d.ts

@@ -0,0 +1,96 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * This object represents files hosted on Stripe's servers. You can upload
+     * files with the [create file](https://api.stripe.com#create_file) request
+     * (for example, when uploading dispute evidence). Stripe also
+     * creates files independently (for example, the results of a [Sigma scheduled
+     * query](https://docs.stripe.com/api#scheduled_queries)).
+     *
+     * Related guide: [File upload guide](https://docs.stripe.com/file-upload)
+     */
+    interface File {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'file';
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * The file expires and isn't available at this time in epoch seconds.
+       */
+      expires_at: number | null;
+
+      /**
+       * The suitable name for saving the file to a filesystem.
+       */
+      filename: string | null;
+
+      /**
+       * A list of [file links](https://api.stripe.com#file_links) that point at this file.
+       */
+      links?: ApiList<Stripe.FileLink> | null;
+
+      /**
+       * The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file.
+       */
+      purpose: File.Purpose;
+
+      /**
+       * The size of the file object in bytes.
+       */
+      size: number;
+
+      /**
+       * A suitable title for the document.
+       */
+      title: string | null;
+
+      /**
+       * The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
+       */
+      type: string | null;
+
+      /**
+       * Use your live secret API key to download the file from this URL.
+       */
+      url: string | null;
+    }
+
+    namespace File {
+      type Purpose =
+        | 'account_requirement'
+        | 'additional_verification'
+        | 'business_icon'
+        | 'business_logo'
+        | 'customer_signature'
+        | 'dispute_evidence'
+        | 'document_provider_identity_document'
+        | 'finance_report_run'
+        | 'financial_account_statement'
+        | 'identity_document'
+        | 'identity_document_downloadable'
+        | 'issuing_regulatory_reporting'
+        | 'pci_document'
+        | 'platform_terms_of_service'
+        | 'selfie'
+        | 'sigma_scheduled_query'
+        | 'tax_document_user_upload'
+        | 'terminal_android_apk'
+        | 'terminal_reader_splashscreen'
+        | 'terminal_wifi_certificate'
+        | 'terminal_wifi_private_key';
+    }
+  }
+}

package/types/FilesResource.d.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface FileCreateParams {
+      /**
+       * A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
+       */
+      file: FileData;
+
+      /**
+       * The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file.
+       */
+      purpose: FileCreateParams.Purpose;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Optional parameters that automatically create a [file link](https://api.stripe.com#file_links) for the newly created file.
+       */
+      file_link_data?: FileCreateParams.FileLinkData;
+    }
+
+    namespace FileCreateParams {
+      interface FileLinkData {
+        /**
+         * Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, `terminal_android_apk`, or `terminal_reader_splashscreen`.
+         */
+        create: boolean;
+
+        /**
+         * The link isn't available after this future timestamp.
+         */
+        expires_at?: number;
+
+        /**
+         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+         */
+        metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
+      }
+
+      type Purpose =
+        | 'account_requirement'
+        | 'additional_verification'
+        | 'business_icon'
+        | 'business_logo'
+        | 'customer_signature'
+        | 'dispute_evidence'
+        | 'identity_document'
+        | 'issuing_regulatory_reporting'
+        | 'pci_document'
+        | 'platform_terms_of_service'
+        | 'tax_document_user_upload'
+        | 'terminal_android_apk'
+        | 'terminal_reader_splashscreen'
+        | 'terminal_wifi_certificate'
+        | 'terminal_wifi_private_key';
+    }
+
+    interface FileRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface FileListParams extends PaginationParams {
+      /**
+       * Only return files that were created during the given date interval.
+       */
+      created?: Stripe.RangeQueryParam | number;
+
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
+       */
+      purpose?: FileListParams.Purpose;
+    }
+
+    namespace FileListParams {
+      type Purpose =
+        | 'account_requirement'
+        | 'additional_verification'
+        | 'business_icon'
+        | 'business_logo'
+        | 'customer_signature'
+        | 'dispute_evidence'
+        | 'document_provider_identity_document'
+        | 'finance_report_run'
+        | 'financial_account_statement'
+        | 'identity_document'
+        | 'identity_document_downloadable'
+        | 'issuing_regulatory_reporting'
+        | 'pci_document'
+        | 'platform_terms_of_service'
+        | 'selfie'
+        | 'sigma_scheduled_query'
+        | 'tax_document_user_upload'
+        | 'terminal_android_apk'
+        | 'terminal_reader_splashscreen'
+        | 'terminal_wifi_certificate'
+        | 'terminal_wifi_private_key';
+    }
+
+    class FilesResource {
+      /**
+       * To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
+       *
+       * All of Stripe's officially supported Client libraries support sending multipart/form-data.
+       */
+      create(
+        params: FileCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.File>>;
+
+      /**
+       * Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://docs.stripe.com/docs/file-upload#download-file-contents).
+       */
+      retrieve(
+        id: string,
+        params?: FileRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.File>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.File>>;
+
+      /**
+       * Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
+       */
+      list(
+        params?: FileListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.File>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.File>;
+    }
+  }
+}

package/types/FinancialConnections/AccountOwners.d.ts

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * Describes an owner of an account.
+       */
+      interface AccountOwner {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.account_owner';
+
+        /**
+         * The email address of the owner.
+         */
+        email: string | null;
+
+        /**
+         * The full name of the owner.
+         */
+        name: string;
+
+        /**
+         * The ownership object that this owner belongs to.
+         */
+        ownership: string;
+
+        /**
+         * The raw phone number of the owner.
+         */
+        phone: string | null;
+
+        /**
+         * The raw physical address of the owner.
+         */
+        raw_address: string | null;
+
+        /**
+         * The timestamp of the refresh that updated this owner.
+         */
+        refreshed_at: number | null;
+      }
+    }
+  }
+}

package/types/FinancialConnections/AccountOwnerships.d.ts

@@ -0,0 +1,32 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    namespace FinancialConnections {
+      /**
+       * Describes a snapshot of the owners of an account at a particular point in time.
+       */
+      interface AccountOwnership {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+
+        /**
+         * String representing the object's type. Objects of the same type share the same value.
+         */
+        object: 'financial_connections.account_ownership';
+
+        /**
+         * Time at which the object was created. Measured in seconds since the Unix epoch.
+         */
+        created: number;
+
+        /**
+         * A paginated list of owners for this account.
+         */
+        owners: ApiList<Stripe.FinancialConnections.AccountOwner>;
+      }
+    }
+  }
+}