Class EventDestinationsResource

Index

Constructors

constructor

Methods

create retrieve update list del disable enable ping

Constructors

constructor

new EventDestinationsResource(): EventDestinationsResource
Returns EventDestinationsResource

Methods

create

create(
params: Stripe.V2.Core.EventDestinationCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.EventDestination>>
Create a new event destination.
Parameters
- params: Stripe.V2.Core.EventDestinationCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.EventDestination>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:183

retrieve

retrieve(
    id: string,
    params?: EventDestinationRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.EventDestination>>
Retrieves the details of an event destination.
Parameters
- id: string
- Optionalparams: EventDestinationRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.EventDestination>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:191
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.EventDestination>>
Retrieves the details of an event destination.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.EventDestination>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:196

update

update(
    id: string,
    params?: Stripe.V2.Core.EventDestinationUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.EventDestination>>
Update the details of an event destination.
Parameters
- id: string
- Optionalparams: Stripe.V2.Core.EventDestinationUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.EventDestination>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:204

list

list(
params?: EventDestinationListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.V2.Core.EventDestination>
Lists all event destinations.
Parameters
- Optionalparams: EventDestinationListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.V2.Core.EventDestination>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:213
list(options?: RequestOptions): ApiListPromise<Stripe.V2.Core.EventDestination>
Lists all event destinations.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.V2.Core.EventDestination>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:217

del

del(
    id: string,
    params?: EventDestinationDeleteParams,
    options?: RequestOptions,
): Promise<Response<DeletedObject>>
Delete an event destination.
Parameters
- id: string
- Optionalparams: EventDestinationDeleteParams
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedObject>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:224
del(id: string, options?: RequestOptions): Promise<Response<DeletedObject>>
Delete an event destination.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedObject>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:229

disable

disable(
    id: string,
    params?: EventDestinationDisableParams,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.EventDestination>>
Disable an event destination.
Parameters
- id: string
- Optionalparams: EventDestinationDisableParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.EventDestination>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:237
disable(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.EventDestination>>
Disable an event destination.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.EventDestination>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:242

enable

enable(
    id: string,
    params?: EventDestinationEnableParams,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.EventDestination>>
Enable an event destination.
Parameters
- id: string
- Optionalparams: EventDestinationEnableParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.EventDestination>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:250
enable(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.EventDestination>>
Enable an event destination.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.EventDestination>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:255

ping

ping(
    id: string,
    params?: EventDestinationPingParams,
    options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.Event>>
Send a ping event to an event destination.
Parameters
- id: string
- Optionalparams: EventDestinationPingParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.Event>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:263
ping(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.V2.Core.Event>>
Send a ping event to an event destination.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.V2.Core.Event>>
- Defined in node_modules/stripe/types/V2/Core/EventDestinationsResource.d.ts:268

Class EventDestinationsResource

Index

Constructors

Methods

Constructors

constructor

Returns EventDestinationsResource

Methods

create

Parameters

Returns Promise<Response<Stripe.V2.Core.EventDestination>>

retrieve

Parameters

Returns Promise<Response<Stripe.V2.Core.EventDestination>>

Parameters

Returns Promise<Response<Stripe.V2.Core.EventDestination>>

update

Parameters

Returns Promise<Response<Stripe.V2.Core.EventDestination>>

list

Parameters

Returns ApiListPromise<Stripe.V2.Core.EventDestination>

Parameters

Returns ApiListPromise<Stripe.V2.Core.EventDestination>

del

Parameters

Returns Promise<Response<DeletedObject>>

Parameters

Returns Promise<Response<DeletedObject>>

disable

Parameters

Returns Promise<Response<Stripe.V2.Core.EventDestination>>

Parameters

Returns Promise<Response<Stripe.V2.Core.EventDestination>>

enable

Parameters

Returns Promise<Response<Stripe.V2.Core.EventDestination>>

Parameters

Returns Promise<Response<Stripe.V2.Core.EventDestination>>

ping

Parameters

Returns Promise<Response<Stripe.V2.Core.Event>>

Parameters

Returns Promise<Response<Stripe.V2.Core.Event>>

Settings

On This Page