Class ConfigurationsResource

Index

Constructors

constructor

Methods

create retrieve update list del

Constructors

constructor

new ConfigurationsResource(): Stripe.Terminal.ConfigurationsResource
Returns Stripe.Terminal.ConfigurationsResource

Methods

create

create(
params?: Stripe.Terminal.ConfigurationCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Configuration>>
Creates a new Configuration object.
Parameters
- Optionalparams: Stripe.Terminal.ConfigurationCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Configuration>>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1353
create(
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Configuration>>
Creates a new Configuration object.
Parameters
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Configuration>>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1357

retrieve

retrieve(
    id: string,
    params?: Stripe.Terminal.ConfigurationRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>
Retrieves a Configuration object.
Parameters
- id: string
- Optionalparams: Stripe.Terminal.ConfigurationRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1364
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>
Retrieves a Configuration object.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1373

update

update(
    id: string,
    params?: Stripe.Terminal.ConfigurationUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>
Updates a new Configuration object.
Parameters
- id: string
- Optionalparams: Stripe.Terminal.ConfigurationUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1385

list

list(
params?: Stripe.Terminal.ConfigurationListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Terminal.Configuration>
Returns a list of Configuration objects.
Parameters
- Optionalparams: Stripe.Terminal.ConfigurationListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Terminal.Configuration>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1398
list(options?: RequestOptions): ApiListPromise<Stripe.Terminal.Configuration>
Returns a list of Configuration objects.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Terminal.Configuration>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1402

del

del(
    id: string,
    params?: ConfigurationDeleteParams,
    options?: RequestOptions,
): Promise<Response<DeletedConfiguration>>
Deletes a Configuration object.
Parameters
- id: string
- Optionalparams: ConfigurationDeleteParams
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedConfiguration>>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1409
del(
id: string,
options?: RequestOptions,
): Promise<Response<DeletedConfiguration>>
Deletes a Configuration object.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<DeletedConfiguration>>
- Defined in node_modules/stripe/types/Terminal/ConfigurationsResource.d.ts:1414

Class ConfigurationsResource

Index

Constructors

Methods

Constructors

constructor

Returns Stripe.Terminal.ConfigurationsResource

Methods

create

Parameters

Returns Promise<Response<Stripe.Terminal.Configuration>>

Parameters

Returns Promise<Response<Stripe.Terminal.Configuration>>

retrieve

Parameters

Returns Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>

Parameters

Returns Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>

update

Parameters

Returns Promise<Response<Stripe.Terminal.Configuration | DeletedConfiguration>>

list

Parameters

Returns ApiListPromise<Stripe.Terminal.Configuration>

Parameters

Returns ApiListPromise<Stripe.Terminal.Configuration>

del

Parameters

Returns Promise<Response<DeletedConfiguration>>

Parameters

Returns Promise<Response<DeletedConfiguration>>

Settings

On This Page