Class TestClocksResource

Index

Constructors

Methods

create retrieve list del advance

Constructors

constructor

new TestClocksResource(): TestClocksResource
Returns TestClocksResource

Methods

create

create(
params: TestClockCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.TestHelpers.TestClock>>
Creates a new test clock that can be attached to new customers and quotes.
Parameters
- params: TestClockCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.TestHelpers.TestClock>>
- Defined in node_modules/stripe/types/TestHelpers/TestClocksResource.d.ts:55

retrieve

retrieve(
    id: string,
    params?: TestClockRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.TestHelpers.TestClock>>
Retrieves a test clock.
Parameters
- id: string
- Optionalparams: TestClockRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.TestHelpers.TestClock>>
- Defined in node_modules/stripe/types/TestHelpers/TestClocksResource.d.ts:63
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.TestHelpers.TestClock>>
Retrieves a test clock.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.TestHelpers.TestClock>>
- Defined in node_modules/stripe/types/TestHelpers/TestClocksResource.d.ts:68

list

list(
params?: TestClockListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.TestHelpers.TestClock>
Returns a list of your test clocks.
Parameters
- Optionalparams: TestClockListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.TestHelpers.TestClock>
- Defined in node_modules/stripe/types/TestHelpers/TestClocksResource.d.ts:76
list(options?: RequestOptions): ApiListPromise<Stripe.TestHelpers.TestClock>
Returns a list of your test clocks.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.TestHelpers.TestClock>
- Defined in node_modules/stripe/types/TestHelpers/TestClocksResource.d.ts:80

del

del(
    id: string,
    params?: TestClockDeleteParams,
    options?: RequestOptions,
): Promise<Response<DeletedTestClock>>
Deletes a test clock.
Parameters
- id: string
- Optionalparams: TestClockDeleteParams
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedTestClock>>
- Defined in node_modules/stripe/types/TestHelpers/TestClocksResource.d.ts:87
del(id: string, options?: RequestOptions): Promise<Response<DeletedTestClock>>
Deletes a test clock.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedTestClock>>
- Defined in node_modules/stripe/types/TestHelpers/TestClocksResource.d.ts:92

advance

advance(
    id: string,
    params: TestClockAdvanceParams,
    options?: RequestOptions,
): Promise<Response<Stripe.TestHelpers.TestClock>>
Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
Parameters
- id: string
- params: TestClockAdvanceParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.TestHelpers.TestClock>>
- Defined in node_modules/stripe/types/TestHelpers/TestClocksResource.d.ts:100