Class FileLinksResource

Index

Constructors

Methods

create retrieve update list

Constructors

constructor

new FileLinksResource(): FileLinksResource
Returns FileLinksResource

Methods

create

create(
params: FileLinkCreateParams,
options?: RequestOptions,
): Promise<Response<FileLink>>
Creates a new file link object.
Parameters
- params: FileLinkCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<FileLink>>
- Defined in node_modules/stripe/types/FileLinksResource.d.ts:77

retrieve

retrieve(
    id: string,
    params?: FileLinkRetrieveParams,
    options?: RequestOptions,
): Promise<Response<FileLink>>
Retrieves the file link with the given ID.
Parameters
- id: string
- Optionalparams: FileLinkRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<FileLink>>
- Defined in node_modules/stripe/types/FileLinksResource.d.ts:85
retrieve(id: string, options?: RequestOptions): Promise<Response<FileLink>>
Retrieves the file link with the given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<FileLink>>
- Defined in node_modules/stripe/types/FileLinksResource.d.ts:90

update

update(
    id: string,
    params?: FileLinkUpdateParams,
    options?: RequestOptions,
): Promise<Response<FileLink>>
Updates an existing file link object. Expired links can no longer be updated.
Parameters
- id: string
- Optionalparams: FileLinkUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<FileLink>>
- Defined in node_modules/stripe/types/FileLinksResource.d.ts:98

list

list(
params?: FileLinkListParams,
options?: RequestOptions,
): ApiListPromise<FileLink>
Returns a list of file links.
Parameters
- Optionalparams: FileLinkListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<FileLink>
- Defined in node_modules/stripe/types/FileLinksResource.d.ts:107
list(options?: RequestOptions): ApiListPromise<FileLink>
Returns a list of file links.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<FileLink>
- Defined in node_modules/stripe/types/FileLinksResource.d.ts:111