SavingsPlan interface
Interface que representa um SavingsPlan.
Métodos
get(string, string, Savings |
Obtenha um plano de poupança. |
list(string, Savings |
Liste os planos de poupança em uma ordem. |
list |
Listar planos de poupança. |
update(string, string, Savings |
Atualizar plano de poupança. |
validate |
Valide o patch do plano de poupança. |
Detalhes de Método
get(string, string, SavingsPlanGetOptionalParams)
Obtenha um plano de poupança.
function get(savingsPlanOrderId: string, savingsPlanId: string, options?: SavingsPlanGetOptionalParams): Promise<SavingsPlanModel>
Parâmetros
- savingsPlanOrderId
-
string
ID do pedido do plano de poupança
- savingsPlanId
-
string
ID do plano de poupança
- options
- SavingsPlanGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<SavingsPlanModel>
list(string, SavingsPlanListOptionalParams)
Liste os planos de poupança em uma ordem.
function list(savingsPlanOrderId: string, options?: SavingsPlanListOptionalParams): PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>
Parâmetros
- savingsPlanOrderId
-
string
ID do pedido do plano de poupança
- options
- SavingsPlanListOptionalParams
Os parâmetros de opções.
Devoluções
listAll(SavingsPlanListAllOptionalParams)
Listar planos de poupança.
function listAll(options?: SavingsPlanListAllOptionalParams): PagedAsyncIterableIterator<SavingsPlanModel, SavingsPlanModel[], PageSettings>
Parâmetros
- options
- SavingsPlanListAllOptionalParams
Os parâmetros de opções.
Devoluções
update(string, string, SavingsPlanUpdateRequest, SavingsPlanUpdateOptionalParams)
Atualizar plano de poupança.
function update(savingsPlanOrderId: string, savingsPlanId: string, body: SavingsPlanUpdateRequest, options?: SavingsPlanUpdateOptionalParams): Promise<SavingsPlanModel>
Parâmetros
- savingsPlanOrderId
-
string
ID do pedido do plano de poupança
- savingsPlanId
-
string
ID do plano de poupança
Corpo de solicitação para corrigir um alias de pedido de plano de poupança
- options
- SavingsPlanUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<SavingsPlanModel>
validateUpdate(string, string, SavingsPlanUpdateValidateRequest, SavingsPlanValidateUpdateOptionalParams)
Valide o patch do plano de poupança.
function validateUpdate(savingsPlanOrderId: string, savingsPlanId: string, body: SavingsPlanUpdateValidateRequest, options?: SavingsPlanValidateUpdateOptionalParams): Promise<SavingsPlanValidateResponse>
Parâmetros
- savingsPlanOrderId
-
string
ID do pedido do plano de poupança
- savingsPlanId
-
string
ID do plano de poupança
Corpo da solicitação para validar uma solicitação de patch do plano de poupança
Os parâmetros de opções.
Devoluções
Promise<SavingsPlanValidateResponse>