Documentation ¶
Overview ¶
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
* Hydrogen Admin API * * The Hydrogen Admin API * * API version: 1.0.0 * Contact: info@hydrogenplatform.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type AppConfig
- type AppToken
- type AppTokenApiGetAppTokenUsingGETOpts
- type AppTokenApiService
- type AppTokenConfig
- type Auth
- type AutoGenerateAppTokenApiGetAppTokenUsingGETOpts
- type AutoGenerateAppTokenApiService
- func (a *AutoGenerateAppTokenApiService) CreateClientCredential(ctx context.Context, clientId string, clientSecret string) (Auth, *http.Response, error)
- func (a *AutoGenerateAppTokenApiService) CreatePasswordCredential(ctx context.Context, clientId string, clientSecret string, username string, ...) (Auth, *http.Response, error)
- func (a *AutoGenerateAppTokenApiService) GetAppTokenUsingGET(ctx context.Context, appTokenConfig AppTokenConfig) ([]map[string]string, *http.Response, error)
- func (a *AutoGenerateAppTokenApiService) GetAttribMapList(appTokenConfig AppTokenConfig) []string
- func (a *AutoGenerateAppTokenApiService) GetToken(ctx context.Context, appName []string, ...) ([]AppToken, *http.Response, error)
- type BasicAuth
- type Card
- type CardAddress
- type CardApiGetCardAllUsingGetOpts
- type CardApiService
- func (a *CardApiService) CreateCardUsingPost(ctx context.Context, cardRequest Card, appTokenConfig AppTokenConfig) (Card, *http.Response, error)
- func (a *CardApiService) CreateClientCredential(ctx context.Context, clientId string, clientSecret string) (Auth, *http.Response, error)
- func (a *CardApiService) CreateClientTokenCredential(ctx context.Context, clientId string, clientSecret string, client_token string) (Auth, *http.Response, error)
- func (a *CardApiService) CreatePasswordCredential(ctx context.Context, clientId string, clientSecret string, username string, ...) (Auth, *http.Response, error)
- func (a *CardApiService) GetCardAllUsingGet(ctx context.Context, localVarOptionals *CardApiGetCardAllUsingGetOpts, ...) (PageCard, *http.Response, error)
- func (a *CardApiService) GetCardUsingGet(ctx context.Context, cardId string, appTokenConfig AppTokenConfig) (Card, *http.Response, error)
- func (a *CardApiService) UpdateCardUsingPut(ctx context.Context, card interface{}, cardId string, ...) (Card, *http.Response, error)
- type Client
- type ClientAddress
- type ClientApiGetClientAllUsingGetOpts
- type ClientApiService
- func (a *ClientApiService) CreateClientCredential(ctx context.Context, clientId string, clientSecret string) (Auth, *http.Response, error)
- func (a *ClientApiService) CreateClientTokenCredential(ctx context.Context, clientId string, clientSecret string, client_token string) (Auth, *http.Response, error)
- func (a *ClientApiService) CreateClientUsingPost(ctx context.Context, clientRequest Client, appTokenConfig AppTokenConfig) (Client, *http.Response, error)
- func (a *ClientApiService) CreatePasswordCredential(ctx context.Context, clientId string, clientSecret string, username string, ...) (Auth, *http.Response, error)
- func (a *ClientApiService) GetClientAllUsingGet(ctx context.Context, localVarOptionals *ClientApiGetClientAllUsingGetOpts, ...) (PageClient, *http.Response, error)
- func (a *ClientApiService) GetClientUsingGet(ctx context.Context, clientId string, appTokenConfig AppTokenConfig) (Client, *http.Response, error)
- func (a *ClientApiService) UpdateClientUsingPut(ctx context.Context, client interface{}, clientId string, ...) (Client, *http.Response, error)
- type Configuration
- type Employment
- type GenericSwaggerError
- type PageCard
- type PageClient
- type ResponseEntity
- type Sort
- type TagAttributes
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes a oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct { AppTokenApi *AppTokenApiService // contains filtered or unexported fields }
APIClient manages communication with the Hydrogen Admin API API v1.4.0 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
Change base path to allow switching to mocks
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct { *http.Response `json:"-"` Message string `json:"message,omitempty"` // Operation is the name of the swagger operation. Operation string `json:"operation,omitempty"` // RequestURL is the request URL. This value is always available, even if the // embedded *http.Response is nil. RequestURL string `json:"url,omitempty"` // Method is the HTTP method used for the request. This value is always // available, even if the embedded *http.Response is nil. Method string `json:"method,omitempty"` // Payload holds the contents of the response body (which may be nil or empty). // This is provided here as the raw response.Body() reader will have already // been drained. Payload []byte `json:"-"` }
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
type AppToken ¶
type AppToken struct { AppName string `json:"app_name,omitempty"` AppToken string `json:"app_token,omitempty"` CreateDate string `json:"create_date,omitempty"` Id string `json:"id,omitempty"` IsValid bool `json:"is_valid,omitempty"` TenantName string `json:"tenant_name,omitempty"` UpdateDate string `json:"update_date,omitempty"` Username string `json:"username,omitempty"` }
type AppTokenApiService ¶
type AppTokenApiService service
func (*AppTokenApiService) GetAppTokenUsingGET ¶
func (a *AppTokenApiService) GetAppTokenUsingGET(ctx context.Context, appName []string, localVarOptionals *AppTokenApiGetAppTokenUsingGETOpts) ([]AppToken, *http.Response, error)
type AppTokenConfig ¶
type AppTokenConfig struct { ClientId string `json:"client_id,omitempty"` AuthType string `json:"client_id,omitempty"` ClientToken string `json:"client_id,omitempty"` ClientSecret string `json:"client_secret,omitempty"` Username string `json:"username,omitempty"` Password string `json:"password,omitempty"` PublicKey string `json:"public_key,omitempty"` AccessToken string `json:"access_token,omitempty"` BasePath string `json:"base_path,omitempty"` IsEmbed bool `json:"is_embed,omitempty"` AppNames []AppConfig `json:"app_names,omitempty"` Attributes []TagAttributes `json:"attributes,omitempty"` }
type AutoGenerateAppTokenApiService ¶
type AutoGenerateAppTokenApiService service
func (*AutoGenerateAppTokenApiService) CreateClientCredential ¶
func (*AutoGenerateAppTokenApiService) CreatePasswordCredential ¶
func (*AutoGenerateAppTokenApiService) GetAppTokenUsingGET ¶
func (a *AutoGenerateAppTokenApiService) GetAppTokenUsingGET(ctx context.Context, appTokenConfig AppTokenConfig) ([]map[string]string, *http.Response, error)
func (*AutoGenerateAppTokenApiService) GetAttribMapList ¶
func (a *AutoGenerateAppTokenApiService) GetAttribMapList(appTokenConfig AppTokenConfig) []string
type BasicAuth ¶
type BasicAuth struct { UserName string `json:"userName,omitempty"` Password string `json:"password,omitempty"` }
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type Card ¶
type Card struct { Address []CardAddress `json:"address,omitempty"` // businessId BusinessId string `json:"business_id,omitempty"` // cardHolderName CardHolderName string `json:"card_holder_name"` // card_image CardImage string `json:"card_image,omitempty"` // cardIssuance CardIssuance string `json:"card_issuance"` // cardName CardName string `json:"card_name"` // cardNetwork CardNetwork string `json:"card_network,omitempty"` // cardProgramId CardProgramId string `json:"card_program_id,omitempty"` // cardType CardType string `json:"card_type"` // clientId ClientId string `json:"client_id,omitempty"` CreateDate time.Time `json:"create_date,omitempty"` // creditLimit CreditLimit float64 `json:"credit_limit,omitempty"` // currencyCode CurrencyCode string `json:"currency_code,omitempty"` // expiryDate ExpiryDate string `json:"expiry_date,omitempty"` // fulfillment Fulfillment string `json:"fulfillment,omitempty"` Id string `json:"id,omitempty"` // institutionId InstitutionId string `json:"institution_id,omitempty"` // institutionName InstitutionName string `json:"institution_name,omitempty"` // is_active IsActive bool `json:"is_active,omitempty"` // is_pin_set IsPinSet bool `json:"is_pin_set,omitempty"` // is_primary IsPrimary bool `json:"is_primary,omitempty"` // is_reloadable IsReloadable bool `json:"is_reloadable,omitempty"` // mask Mask string `json:"mask,omitempty"` Metadata map[string]string `json:"metadata,omitempty"` // phoneNumber PhoneNumber string `json:"phone_number,omitempty"` // portfolioId PortfolioId string `json:"portfolio_id"` // prepaidAmount PrepaidAmount float32 `json:"prepaid_amount,omitempty"` SecondaryId string `json:"secondary_id,omitempty"` // status Status string `json:"status,omitempty"` UpdateDate time.Time `json:"update_date,omitempty"` }
Card Object
type CardAddress ¶
type CardAddress struct { // addressLine1 AddressLine1 string `json:"address_line1"` // addressLine2 AddressLine2 string `json:"address_line2,omitempty"` // city City string `json:"city"` // country Country string `json:"country"` // postalcode Postalcode string `json:"postalcode,omitempty"` // state State string `json:"state"` // type Type_ string `json:"type"` }
CardAddress Object
type CardApiService ¶
type CardApiService service
func (*CardApiService) CreateCardUsingPost ¶
func (a *CardApiService) CreateCardUsingPost(ctx context.Context, cardRequest Card, appTokenConfig AppTokenConfig) (Card, *http.Response, error)
CardApiService Create a card request Create a new card request.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param cardRequest cardRequest
@return Card
func (*CardApiService) CreateClientCredential ¶
func (*CardApiService) CreateClientTokenCredential ¶
func (*CardApiService) CreatePasswordCredential ¶
func (*CardApiService) GetCardAllUsingGet ¶
func (a *CardApiService) GetCardAllUsingGet(ctx context.Context, localVarOptionals *CardApiGetCardAllUsingGetOpts, appTokenConfig AppTokenConfig) (PageCard, *http.Response, error)
func (*CardApiService) GetCardUsingGet ¶
func (a *CardApiService) GetCardUsingGet(ctx context.Context, cardId string, appTokenConfig AppTokenConfig) (Card, *http.Response, error)
CardApiService Retrieve a card request Retrieve the information for a card request.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param cardId UUID card_id
@return Card
func (*CardApiService) UpdateCardUsingPut ¶
func (a *CardApiService) UpdateCardUsingPut(ctx context.Context, card interface{}, cardId string, appTokenConfig AppTokenConfig) (Card, *http.Response, error)
CardApiService Update a card request Update the information for a card request.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param card card
- @param cardId UUID card_id
@return Card
type Client ¶
type Client struct { Address []ClientAddress `json:"address,omitempty"` // authorities Authorities []string `json:"authorities,omitempty"` // business_id BusinessId string `json:"business_id,omitempty"` // citizenshipStatus CitizenshipStatus string `json:"citizenship_status,omitempty"` // clientTypeId ClientType string `json:"client_type"` // countryOfCitizenship CountryOfCitizenship []string `json:"country_of_citizenship,omitempty"` // countryOfResidence CountryOfResidence string `json:"country_of_residence,omitempty"` CreateDate string `json:"create_date,omitempty"` // dateOfBirth DateOfBirth string `json:"date_of_birth,omitempty"` // email Email string `json:"email,omitempty"` Employment *Employment `json:"employment,omitempty"` // firmName FirmName string `json:"firm_name,omitempty"` // firmType FirmType string `json:"firm_type,omitempty"` // firstName FirstName string `json:"first_name,omitempty"` // gender Gender string `json:"gender,omitempty"` // group Group []string `json:"group,omitempty"` // hydroId HydroId string `json:"hydro_id,omitempty"` Id string `json:"id,omitempty"` // identificationNumber IdentificationNumber string `json:"identification_number,omitempty"` // identificationNumberType IdentificationNumberType string `json:"identification_number_type,omitempty"` // image Image string `json:"image,omitempty"` // income Income int32 `json:"income,omitempty"` // isActive IsActive bool `json:"is_active,omitempty"` // isVerified IsVerified bool `json:"is_verified,omitempty"` // last_name LastName string `json:"last_name,omitempty"` // liquidNetWorth LiquidNetWorth float64 `json:"liquid_net_worth,omitempty"` // metadata Metadata map[string]string `json:"metadata,omitempty"` // middleName MiddleName string `json:"middle_name,omitempty"` // password Password string `json:"password,omitempty"` // phoneNumber PhoneNumber string `json:"phone_number,omitempty"` SecondaryId string `json:"secondary_id,omitempty"` // status Status string `json:"status,omitempty"` // suffix Suffix string `json:"suffix,omitempty"` // title Title string `json:"title,omitempty"` // totalNetWorth TotalNetWorth float64 `json:"total_net_worth,omitempty"` UpdateDate string `json:"update_date,omitempty"` // username Username string `json:"username"` }
Client Object
type ClientAddress ¶
type ClientAddress struct { // addressLine1 AddressLine1 string `json:"address_line1"` // addressLine2 AddressLine2 string `json:"address_line2,omitempty"` // city City string `json:"city"` // country Country string `json:"country"` // is_primary IsPrimary bool `json:"is_primary,omitempty"` // postalcode Postalcode string `json:"postalcode,omitempty"` // state State string `json:"state"` // type Type_ string `json:"type"` }
ClientAddress Object
type ClientApiService ¶
type ClientApiService service
func (*ClientApiService) CreateClientCredential ¶
func (*ClientApiService) CreateClientTokenCredential ¶
func (*ClientApiService) CreateClientUsingPost ¶
func (a *ClientApiService) CreateClientUsingPost(ctx context.Context, clientRequest Client, appTokenConfig AppTokenConfig) (Client, *http.Response, error)
ClientApiService Create a client Create a new client, or register a new user, with your firm.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clientRequest clientRequest
@return Client
func (*ClientApiService) CreatePasswordCredential ¶
func (*ClientApiService) GetClientAllUsingGet ¶
func (a *ClientApiService) GetClientAllUsingGet(ctx context.Context, localVarOptionals *ClientApiGetClientAllUsingGetOpts, appTokenConfig AppTokenConfig) (PageClient, *http.Response, error)
func (*ClientApiService) GetClientUsingGet ¶
func (a *ClientApiService) GetClientUsingGet(ctx context.Context, clientId string, appTokenConfig AppTokenConfig) (Client, *http.Response, error)
ClientApiService Retrieve a client Retrieve the information for a client registered with your firm.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param clientId UUID client_id
@return Client
func (*ClientApiService) UpdateClientUsingPut ¶
func (a *ClientApiService) UpdateClientUsingPut(ctx context.Context, client interface{}, clientId string, appTokenConfig AppTokenConfig) (Client, *http.Response, error)
ClientApiService Update a client Update the information for a client registered with your firm.
- @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param client client
- @param clientId UUID client_id
@return Client
type Configuration ¶
type Configuration struct { BasePath string `json:"basePath,omitempty"` Host string `json:"host,omitempty"` Scheme string `json:"scheme,omitempty"` DefaultHeader map[string]string `json:"defaultHeader,omitempty"` UserAgent string `json:"userAgent,omitempty"` HTTPClient *http.Client }
func NewConfiguration ¶
func NewConfiguration() *Configuration
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
type Employment ¶
type Employment struct { // employer Employer string `json:"employer,omitempty"` // employmentStatus EmploymentStatus string `json:"employment_status,omitempty"` // jobTitle JobTitle string `json:"job_title,omitempty"` // occupation Occupation string `json:"occupation,omitempty"` }
Employment Object
type GenericSwaggerError ¶
type GenericSwaggerError struct {
// contains filtered or unexported fields
}
GenericSwaggerError Provides access to the body, error and model on returned errors.
func (GenericSwaggerError) Body ¶
func (e GenericSwaggerError) Body() []byte
Body returns the raw bytes of the response
func (GenericSwaggerError) Error ¶
func (e GenericSwaggerError) Error() string
Error returns non-empty string if there was an error.
func (GenericSwaggerError) Model ¶
func (e GenericSwaggerError) Model() interface{}
Model returns the unpacked model of the error
type PageCard ¶
type PageCard struct { Content []Card `json:"content,omitempty"` First bool `json:"first,omitempty"` Last bool `json:"last,omitempty"` Number int32 `json:"number,omitempty"` NumberOfElements int32 `json:"number_of_elements,omitempty"` Size int32 `json:"size,omitempty"` Sort []Sort `json:"sort,omitempty"` TotalElements int64 `json:"total_elements,omitempty"` TotalPages int32 `json:"total_pages,omitempty"` }
Page Object
type PageClient ¶
type PageClient struct { Content []Client `json:"content,omitempty"` First bool `json:"first,omitempty"` Last bool `json:"last,omitempty"` Number int32 `json:"number,omitempty"` NumberOfElements int32 `json:"number_of_elements,omitempty"` Size int32 `json:"size,omitempty"` Sort []Sort `json:"sort,omitempty"` TotalElements int64 `json:"total_elements,omitempty"` TotalPages int32 `json:"total_pages,omitempty"` }
Page Object
type ResponseEntity ¶
type Sort ¶
type Sort struct { // ascending Ascending bool `json:"ascending,omitempty"` // descending Descending bool `json:"descending,omitempty"` // direction Direction string `json:"direction,omitempty"` // ignoreCase IgnoreCase bool `json:"ignore_case,omitempty"` // nullHandling NullHandling string `json:"null_handling,omitempty"` // property Property string `json:"property,omitempty"` }
Sort Object
type TagAttributes ¶
Source Files ¶
- api_app_token.go
- api_card.go
- api_client.go
- auto_generate_api_app_token.go
- client.go
- configuration.go
- model_app_config.go
- model_app_token.go
- model_app_token_config.go
- model_auth.go
- model_card.go
- model_card_address.go
- model_client.go
- model_client_address.go
- model_employment.go
- model_page_card.go
- model_page_client.go
- model_response_entity.go
- model_sort.go
- model_tag_attributes.go
- response.go