@ringer-tel/ivy
Version:
TypeScript SDK for Ringer APIs
98 lines (87 loc) • 3.5 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* Ringer Business API
* This API provides comprehensive endpoints for the Ringer Business system. It includes functionality for managing customer accounts, addresses, sites, phone numbers, payments, users, and other business resources. Operations typically require authentication and appropriate permissions.
*
* The version of the OpenAPI document: 1.0.6
* Contact: support@ringer.tel
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { mapValues } from '../runtime';
/**
* Specifies the fields that can be updated for an account.
* @export
* @interface AccountUpdateRequest
*/
export interface AccountUpdateRequest {
/**
* The official name of the account/company.
* @type {string}
* @memberof AccountUpdateRequest
*/
name?: string;
/**
* Preferred language and regional settings (e.g., "en-US", "en-GB").
* @type {string}
* @memberof AccountUpdateRequest
*/
locale?: string;
/**
* Desired minimum balance to maintain, in dollars.
* @type {string}
* @memberof AccountUpdateRequest
*/
balancePreferenceInDollars?: string;
/**
* Amount to automatically recharge when balance falls below preference, in dollars.
* @type {string}
* @memberof AccountUpdateRequest
*/
rechargePreferenceInDollars?: string;
/**
* Maximum permissible auto-recharge amount in a single transaction, in dollars.
* @type {string}
* @memberof AccountUpdateRequest
*/
maximumRechargePreferenceInDollars?: string;
}
/**
* Check if a given object implements the AccountUpdateRequest interface.
*/
export function instanceOfAccountUpdateRequest(value: object): value is AccountUpdateRequest {
return true;
}
export function AccountUpdateRequestFromJSON(json: any): AccountUpdateRequest {
return AccountUpdateRequestFromJSONTyped(json, false);
}
export function AccountUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AccountUpdateRequest {
if (json == null) {
return json;
}
return {
'name': json['name'] == null ? undefined : json['name'],
'locale': json['locale'] == null ? undefined : json['locale'],
'balancePreferenceInDollars': json['balance_preference_in_dollars'] == null ? undefined : json['balance_preference_in_dollars'],
'rechargePreferenceInDollars': json['recharge_preference_in_dollars'] == null ? undefined : json['recharge_preference_in_dollars'],
'maximumRechargePreferenceInDollars': json['maximum_recharge_preference_in_dollars'] == null ? undefined : json['maximum_recharge_preference_in_dollars'],
};
}
export function AccountUpdateRequestToJSON(json: any): AccountUpdateRequest {
return AccountUpdateRequestToJSONTyped(json, false);
}
export function AccountUpdateRequestToJSONTyped(value?: AccountUpdateRequest | null, ignoreDiscriminator: boolean = false): any {
if (value == null) {
return value;
}
return {
'name': value['name'],
'locale': value['locale'],
'balance_preference_in_dollars': value['balancePreferenceInDollars'],
'recharge_preference_in_dollars': value['rechargePreferenceInDollars'],
'maximum_recharge_preference_in_dollars': value['maximumRechargePreferenceInDollars'],
};
}