app.cybrid.cybrid_api_bank.client.model.CustomerBankModel Maven / Gradle / Ivy
/*
* Cybrid Bank API
* # Cybrid API documentation Welcome to Cybrid, an all-in-one crypto platform that enables you to easily **build** and **launch** white-label crypto products or services. In these documents, you'll find details on how our REST API operates and generally how our platform functions. If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our [Github repo](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) which contains many helpful links to platform resources. ## Getting Started This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the [Open API 3.0 yaml](https://bank.production.cybrid.app/api/schema/v1/swagger.yaml) for import. If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform: 1. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Introduction](https://docs.cybrid.xyz/docs/how-is-cybrid-architected) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/testing-with-hosted-web-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/how-do-i-get-started-with-the-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://kb.cybrid.xyz/getting-ready-for-trading), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## Working with the Cybrid Platform There are three primary ways you can interact with the Cybrid platform: 1. Directly via our RESTful API (this documentation) 2. Using our API clients available in a variety of languages ([Angular](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-ios)) Our complete set of APIs allows you to manage resources across three distinct areas: your `Organization`, your `Banks` and your `Identities`. For most of your testing and interaction you'll be using the `Bank` API, which is where the majority of APIs reside. *The complete set of APIs can be found on the following pages:* | API | Description | |------------------------------------------------------------------|-------------------------------------------------------------| | [Organization API](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:[email protected]) at any time for assistance, or contact the [Product Team](mailto:[email protected]) for product suggestions. ## Authenticating with the API The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create `Organization` and `Bank` tokens can be generated via the [Cybrid Sandbox](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) as well. An `Organization` access token applies broadly to the whole Organization and all of its `Banks`, whereas, a `Bank` access token is specific to an individual Bank. `Customer` tokens, similarly, are scoped to a specific customer in a bank. Both `Organization` and `Bank` tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique `Client ID` and `Secret` that allows for machine-to-machine authentication. A `Bank` can then generate `Customer` access tokens via API using our [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui). **⚠️ Never share your Client ID or Secret publicly or in your source code repository.** Your `Client ID` and `Secret` can be exchanged for a time-limited `Bearer Token` by interacting with the Cybrid Identity Provider or through interacting with the **Authorize** button in this document. The following curl command can be used to quickly generate a `Bearer Token` for use in testing the API or demo applications. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"\", \"client_secret\": \"\", \"scope\": \"banks:read banks:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:write counterparties:execute customers:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read external_bank_accounts:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:write identity_verifications:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:execute banks:read banks:write banks:execute bank_applications:execute users:read users:execute counterparties:read customers:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:execute external_bank_accounts:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read' ``` **⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.** ## Authentication Scopes The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal. The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the _Read_ scope is required to read and list resources, the _Write_ scope is required to update a resource and the _Execute_ scope is required to create a resource. | Resource | Read scope (Token Type) | Write scope (Token Type) | Execute scope (Token Type) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically does not directly interact with `customers`. Instead, an Organization has one or more `banks`, which encompass the financial service offerings of the platform. **Banks** A `Bank` is owned by an `Organization` and can be thought of as an environment or container for `customers` and product offerings. Banks are created in either `Sandbox` or `Production` mode, where `Sandbox` is the environment that you would test, prototype and build in prior to moving to `Production`. An `Organization` can have multiple `banks`, in either `Sandbox` or `Production` environments. A `Sandbox Bank` will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes. **Customers** `Customers` represent your banking users on the platform. At present, we offer support for `Individuals` as Customers. `Customers` must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and a passing `Identity Verification`. See the Identity Verifications section for more details on how a customer can be verified. `Customers` must also have an `Account` to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.
*
* The version of the OpenAPI document: v0.123.3
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package app.cybrid.cybrid_api_bank.client.model;
import java.util.Objects;
import java.util.Arrays;
import app.cybrid.cybrid_api_bank.client.model.ActivityLimitBankModel;
import app.cybrid.cybrid_api_bank.client.model.ComplianceDecisionBankModel;
import app.cybrid.cybrid_api_bank.client.model.CustomerAddressBankModel;
import app.cybrid.cybrid_api_bank.client.model.CustomerAliasesInnerBankModel;
import app.cybrid.cybrid_api_bank.client.model.CustomerNameBankModel;
import app.cybrid.cybrid_api_bank.client.model.IdentificationNumberBankModel;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.ArrayList;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonTypeName;
/**
* CustomerBankModel
*/
@JsonPropertyOrder({
CustomerBankModel.JSON_PROPERTY_GUID,
CustomerBankModel.JSON_PROPERTY_BANK_GUID,
CustomerBankModel.JSON_PROPERTY_TYPE,
CustomerBankModel.JSON_PROPERTY_CREATED_AT,
CustomerBankModel.JSON_PROPERTY_UPDATED_AT,
CustomerBankModel.JSON_PROPERTY_STATE,
CustomerBankModel.JSON_PROPERTY_NAME,
CustomerBankModel.JSON_PROPERTY_ADDRESS,
CustomerBankModel.JSON_PROPERTY_ALIASES,
CustomerBankModel.JSON_PROPERTY_WEBSITE,
CustomerBankModel.JSON_PROPERTY_DATE_OF_BIRTH,
CustomerBankModel.JSON_PROPERTY_PHONE_NUMBER,
CustomerBankModel.JSON_PROPERTY_EMAIL_ADDRESS,
CustomerBankModel.JSON_PROPERTY_LABELS,
CustomerBankModel.JSON_PROPERTY_COMPLIANCE_DECISIONS,
CustomerBankModel.JSON_PROPERTY_IDENTIFICATION_NUMBERS,
CustomerBankModel.JSON_PROPERTY_ACTIVITY_LIMITS
})
@JsonTypeName("Customer")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-11-18T16:38:08.730462Z[Etc/UTC]")
public class CustomerBankModel {
public static final String JSON_PROPERTY_GUID = "guid";
private String guid;
public static final String JSON_PROPERTY_BANK_GUID = "bank_guid";
private String bankGuid;
public static final String JSON_PROPERTY_TYPE = "type";
private String type;
public static final String JSON_PROPERTY_CREATED_AT = "created_at";
private OffsetDateTime createdAt;
public static final String JSON_PROPERTY_UPDATED_AT = "updated_at";
private OffsetDateTime updatedAt;
public static final String JSON_PROPERTY_STATE = "state";
private String state;
public static final String JSON_PROPERTY_NAME = "name";
private CustomerNameBankModel name;
public static final String JSON_PROPERTY_ADDRESS = "address";
private CustomerAddressBankModel address;
public static final String JSON_PROPERTY_ALIASES = "aliases";
private List aliases = null;
public static final String JSON_PROPERTY_WEBSITE = "website";
private String website;
public static final String JSON_PROPERTY_DATE_OF_BIRTH = "date_of_birth";
private LocalDate dateOfBirth;
public static final String JSON_PROPERTY_PHONE_NUMBER = "phone_number";
private String phoneNumber;
public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address";
private String emailAddress;
public static final String JSON_PROPERTY_LABELS = "labels";
private List labels = null;
public static final String JSON_PROPERTY_COMPLIANCE_DECISIONS = "compliance_decisions";
private List complianceDecisions = null;
public static final String JSON_PROPERTY_IDENTIFICATION_NUMBERS = "identification_numbers";
private List identificationNumbers = null;
public static final String JSON_PROPERTY_ACTIVITY_LIMITS = "activity_limits";
private List activityLimits = null;
public CustomerBankModel() {
}
public CustomerBankModel guid(String guid) {
this.guid = guid;
return this;
}
/**
* Auto-generated unique identifier for the customer.
* @return guid
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Auto-generated unique identifier for the customer.")
@JsonProperty(JSON_PROPERTY_GUID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getGuid() {
return guid;
}
@JsonProperty(JSON_PROPERTY_GUID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setGuid(String guid) {
this.guid = guid;
}
public CustomerBankModel bankGuid(String bankGuid) {
this.bankGuid = bankGuid;
return this;
}
/**
* Auto-generated unique identifier for the customer's bank.
* @return bankGuid
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Auto-generated unique identifier for the customer's bank.")
@JsonProperty(JSON_PROPERTY_BANK_GUID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBankGuid() {
return bankGuid;
}
@JsonProperty(JSON_PROPERTY_BANK_GUID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBankGuid(String bankGuid) {
this.bankGuid = bankGuid;
}
public CustomerBankModel type(String type) {
this.type = type;
return this;
}
/**
* The customer type; one of business or individual.
* @return type
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The customer type; one of business or individual.")
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getType() {
return type;
}
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setType(String type) {
this.type = type;
}
public CustomerBankModel createdAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* ISO8601 datetime the record was created at.
* @return createdAt
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "ISO8601 datetime the record was created at.")
@JsonProperty(JSON_PROPERTY_CREATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public OffsetDateTime getCreatedAt() {
return createdAt;
}
@JsonProperty(JSON_PROPERTY_CREATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCreatedAt(OffsetDateTime createdAt) {
this.createdAt = createdAt;
}
public CustomerBankModel updatedAt(OffsetDateTime updatedAt) {
this.updatedAt = updatedAt;
return this;
}
/**
* ISO8601 datetime the record was last updated at.
* @return updatedAt
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "ISO8601 datetime the record was last updated at.")
@JsonProperty(JSON_PROPERTY_UPDATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public OffsetDateTime getUpdatedAt() {
return updatedAt;
}
@JsonProperty(JSON_PROPERTY_UPDATED_AT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setUpdatedAt(OffsetDateTime updatedAt) {
this.updatedAt = updatedAt;
}
public CustomerBankModel state(String state) {
this.state = state;
return this;
}
/**
* The customer state; one of storing, unverified, verified, rejected, or frozen.
* @return state
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The customer state; one of storing, unverified, verified, rejected, or frozen.")
@JsonProperty(JSON_PROPERTY_STATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getState() {
return state;
}
@JsonProperty(JSON_PROPERTY_STATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setState(String state) {
this.state = state;
}
public CustomerBankModel name(CustomerNameBankModel name) {
this.name = name;
return this;
}
/**
* Get name
* @return name
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CustomerNameBankModel getName() {
return name;
}
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setName(CustomerNameBankModel name) {
this.name = name;
}
public CustomerBankModel address(CustomerAddressBankModel address) {
this.address = address;
return this;
}
/**
* Get address
* @return address
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
@JsonProperty(JSON_PROPERTY_ADDRESS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public CustomerAddressBankModel getAddress() {
return address;
}
@JsonProperty(JSON_PROPERTY_ADDRESS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAddress(CustomerAddressBankModel address) {
this.address = address;
}
public CustomerBankModel aliases(List aliases) {
this.aliases = aliases;
return this;
}
public CustomerBankModel addAliasesItem(CustomerAliasesInnerBankModel aliasesItem) {
if (this.aliases == null) {
this.aliases = new ArrayList<>();
}
this.aliases.add(aliasesItem);
return this;
}
/**
* The customer's aliases. Only available for GET operations when 'include_pii' is set.
* @return aliases
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The customer's aliases. Only available for GET operations when 'include_pii' is set.")
@JsonProperty(JSON_PROPERTY_ALIASES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getAliases() {
return aliases;
}
@JsonProperty(JSON_PROPERTY_ALIASES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setAliases(List aliases) {
this.aliases = aliases;
}
public CustomerBankModel website(String website) {
this.website = website;
return this;
}
/**
* The customer's website. Only available for GET operations when 'include_pii' is set.
* @return website
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The customer's website. Only available for GET operations when 'include_pii' is set.")
@JsonProperty(JSON_PROPERTY_WEBSITE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getWebsite() {
return website;
}
@JsonProperty(JSON_PROPERTY_WEBSITE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setWebsite(String website) {
this.website = website;
}
public CustomerBankModel dateOfBirth(LocalDate dateOfBirth) {
this.dateOfBirth = dateOfBirth;
return this;
}
/**
* The customer's DOB. Only available for GET operations when 'include_pii' is set.
* @return dateOfBirth
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The customer's DOB. Only available for GET operations when 'include_pii' is set.")
@JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public LocalDate getDateOfBirth() {
return dateOfBirth;
}
@JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDateOfBirth(LocalDate dateOfBirth) {
this.dateOfBirth = dateOfBirth;
}
public CustomerBankModel phoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
return this;
}
/**
* The customer's phone number. Only available for GET operations when 'include_pii' is set.
* @return phoneNumber
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The customer's phone number. Only available for GET operations when 'include_pii' is set.")
@JsonProperty(JSON_PROPERTY_PHONE_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPhoneNumber() {
return phoneNumber;
}
@JsonProperty(JSON_PROPERTY_PHONE_NUMBER)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPhoneNumber(String phoneNumber) {
this.phoneNumber = phoneNumber;
}
public CustomerBankModel emailAddress(String emailAddress) {
this.emailAddress = emailAddress;
return this;
}
/**
* The customer's email address. Only available for GET operations when 'include_pii' is set.
* @return emailAddress
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The customer's email address. Only available for GET operations when 'include_pii' is set.")
@JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getEmailAddress() {
return emailAddress;
}
@JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setEmailAddress(String emailAddress) {
this.emailAddress = emailAddress;
}
public CustomerBankModel labels(List labels) {
this.labels = labels;
return this;
}
public CustomerBankModel addLabelsItem(String labelsItem) {
if (this.labels == null) {
this.labels = new ArrayList<>();
}
this.labels.add(labelsItem);
return this;
}
/**
* The labels associated with the customer.
* @return labels
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The labels associated with the customer.")
@JsonProperty(JSON_PROPERTY_LABELS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getLabels() {
return labels;
}
@JsonProperty(JSON_PROPERTY_LABELS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLabels(List labels) {
this.labels = labels;
}
public CustomerBankModel complianceDecisions(List complianceDecisions) {
this.complianceDecisions = complianceDecisions;
return this;
}
public CustomerBankModel addComplianceDecisionsItem(ComplianceDecisionBankModel complianceDecisionsItem) {
if (this.complianceDecisions == null) {
this.complianceDecisions = new ArrayList<>();
}
this.complianceDecisions.add(complianceDecisionsItem);
return this;
}
/**
* The compliance decisions associated with the customer.
* @return complianceDecisions
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The compliance decisions associated with the customer.")
@JsonProperty(JSON_PROPERTY_COMPLIANCE_DECISIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getComplianceDecisions() {
return complianceDecisions;
}
@JsonProperty(JSON_PROPERTY_COMPLIANCE_DECISIONS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setComplianceDecisions(List complianceDecisions) {
this.complianceDecisions = complianceDecisions;
}
public CustomerBankModel identificationNumbers(List identificationNumbers) {
this.identificationNumbers = identificationNumbers;
return this;
}
public CustomerBankModel addIdentificationNumbersItem(IdentificationNumberBankModel identificationNumbersItem) {
if (this.identificationNumbers == null) {
this.identificationNumbers = new ArrayList<>();
}
this.identificationNumbers.add(identificationNumbersItem);
return this;
}
/**
* The customer's identification numbers. Only available for GET operations when 'include_pii' is set and bank has access.
* @return identificationNumbers
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The customer's identification numbers. Only available for GET operations when 'include_pii' is set and bank has access.")
@JsonProperty(JSON_PROPERTY_IDENTIFICATION_NUMBERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getIdentificationNumbers() {
return identificationNumbers;
}
@JsonProperty(JSON_PROPERTY_IDENTIFICATION_NUMBERS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setIdentificationNumbers(List identificationNumbers) {
this.identificationNumbers = identificationNumbers;
}
public CustomerBankModel activityLimits(List activityLimits) {
this.activityLimits = activityLimits;
return this;
}
public CustomerBankModel addActivityLimitsItem(ActivityLimitBankModel activityLimitsItem) {
if (this.activityLimits == null) {
this.activityLimits = new ArrayList<>();
}
this.activityLimits.add(activityLimitsItem);
return this;
}
/**
* The asset limits associated with the customer.
* @return activityLimits
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The asset limits associated with the customer.")
@JsonProperty(JSON_PROPERTY_ACTIVITY_LIMITS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List getActivityLimits() {
return activityLimits;
}
@JsonProperty(JSON_PROPERTY_ACTIVITY_LIMITS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setActivityLimits(List activityLimits) {
this.activityLimits = activityLimits;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CustomerBankModel customer = (CustomerBankModel) o;
return Objects.equals(this.guid, customer.guid) &&
Objects.equals(this.bankGuid, customer.bankGuid) &&
Objects.equals(this.type, customer.type) &&
Objects.equals(this.createdAt, customer.createdAt) &&
Objects.equals(this.updatedAt, customer.updatedAt) &&
Objects.equals(this.state, customer.state) &&
Objects.equals(this.name, customer.name) &&
Objects.equals(this.address, customer.address) &&
Objects.equals(this.aliases, customer.aliases) &&
Objects.equals(this.website, customer.website) &&
Objects.equals(this.dateOfBirth, customer.dateOfBirth) &&
Objects.equals(this.phoneNumber, customer.phoneNumber) &&
Objects.equals(this.emailAddress, customer.emailAddress) &&
Objects.equals(this.labels, customer.labels) &&
Objects.equals(this.complianceDecisions, customer.complianceDecisions) &&
Objects.equals(this.identificationNumbers, customer.identificationNumbers) &&
Objects.equals(this.activityLimits, customer.activityLimits);
}
@Override
public int hashCode() {
return Objects.hash(guid, bankGuid, type, createdAt, updatedAt, state, name, address, aliases, website, dateOfBirth, phoneNumber, emailAddress, labels, complianceDecisions, identificationNumbers, activityLimits);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CustomerBankModel {\n");
sb.append(" guid: ").append(toIndentedString(guid)).append("\n");
sb.append(" bankGuid: ").append(toIndentedString(bankGuid)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" createdAt: ").append(toIndentedString(createdAt)).append("\n");
sb.append(" updatedAt: ").append(toIndentedString(updatedAt)).append("\n");
sb.append(" state: ").append(toIndentedString(state)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" address: ").append(toIndentedString(address)).append("\n");
sb.append(" aliases: ").append(toIndentedString(aliases)).append("\n");
sb.append(" website: ").append(toIndentedString(website)).append("\n");
sb.append(" dateOfBirth: ").append(toIndentedString(dateOfBirth)).append("\n");
sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n");
sb.append(" emailAddress: ").append(toIndentedString(emailAddress)).append("\n");
sb.append(" labels: ").append(toIndentedString(labels)).append("\n");
sb.append(" complianceDecisions: ").append(toIndentedString(complianceDecisions)).append("\n");
sb.append(" identificationNumbers: ").append(toIndentedString(identificationNumbers)).append("\n");
sb.append(" activityLimits: ").append(toIndentedString(activityLimits)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy