analytics

package
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 14, 2023 License: MIT Imports: 23 Imported by: 0

README

Go API client for swagger

SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. v1.0.11 Release Notes * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.11
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://developer.swift.com

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://api.swift.com/bi/banking-analytics/v1

Class Method HTTP request Description
BankingAnalyticsApi BankingAnalytics Get /value-and-currency Banking Data.

Documentation For Models

Documentation For Authorization

oauthPassword

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Author

developer-support@swift.com

Documentation

Overview

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* SWIFT Banking Analytics * * SWIFT Watch Banking Analytics API enables institutions to retrieve their own SWIFT traffic data and the SWIFT totals, extending to the level of value and currency per market. **v1.0.11 Release Notes** * The Test Environment url updated to https://api-pilot.swift.com/bi/banking-analytics/v1 * PaginationLinks Object is defined as optional, as well as property next. * Response examples were udpated to align with the API contract. * Example for Market parameter in the request fixed * * API version: 1.0.11 * Contact: developer-support@swift.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

Constants

This section is empty.

Variables

View Source
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

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	BankingAnalyticsApi *BankingAnalyticsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the SWIFT Banking Analytics API v1.0.11 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

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

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 BankingAnalyticsApiBankingAnalyticsOpts

type BankingAnalyticsApiBankingAnalyticsOpts struct {
	Limit  optional.Interface
	Offset optional.Interface
}

type BankingAnalyticsApiService

type BankingAnalyticsApiService service

func (*BankingAnalyticsApiService) BankingAnalytics

func (a *BankingAnalyticsApiService) BankingAnalytics(ctx context.Context, market Market1Code, reportingPeriod string, localVarOptionals *BankingAnalyticsApiBankingAnalyticsOpts) (InlineResponse200, *http.Response, error)

type BankingData1

type BankingData1 struct {
	Market                         *Market1Code            `json:"market"`
	ReportingPeriod                string                  `json:"reporting_period"`
	DeliveryStatus                 *DeliveryStatus1Choice  `json:"delivery_status"`
	MessageDefinitionIdentifier    *MessageType1Choice     `json:"message_definition_identifier"`
	MyInstitution                  *PartyDetails1          `json:"my_institution"`
	Counterparty                   *PartyDetails1          `json:"counterparty"`
	GeoRoute                       *GeoRoute1Choice        `json:"geo_route"`
	CustomerRoute                  *CustomerRoute1Choice   `json:"customer_route"`
	TransactionsSent               string                  `json:"transactions_sent,omitempty"`
	TransactionsReceived           string                  `json:"transactions_received,omitempty"`
	TotalSwiftTransactionsSent     string                  `json:"total_swift_transactions_sent,omitempty"`
	TotalSwiftTransactionsReceived string                  `json:"total_swift_transactions_received,omitempty"`
	Currency                       *CurrencyDetails1Choice `json:"currency"`
	AmountSent                     *CurrencyAndAmount5     `json:"amount_sent,omitempty"`
	AmountReceived                 *CurrencyAndAmount5     `json:"amount_received,omitempty"`
	TotalSwiftAmountSent           *CurrencyAndAmount5     `json:"total_swift_amount_sent,omitempty"`
	TotalSwiftAmountReceived       *CurrencyAndAmount5     `json:"total_swift_amount_received,omitempty"`
}

Data model describing the banking data resource.

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 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 CountryIdentification2Choice

type CountryIdentification2Choice struct {
	Code        string                          `json:"code,omitempty"`
	Proprietary *ProprietaryCountryInformation1 `json:"proprietary,omitempty"`
}

Identifies a country through an ISO 3166 country code, or a proprietary code.

type CurrencyAndAmount5

type CurrencyAndAmount5 struct {
	Original string `json:"original"`
	UsDollar string `json:"us_dollar"`
	Euro     string `json:"euro"`
}

Specifies the amount in its original currency, in US Dollar and in Euro.

type CurrencyDetails1Choice

type CurrencyDetails1Choice struct {
	Code        string                           `json:"code,omitempty"`
	Proprietary *ProprietaryCurrencyInformation1 `json:"proprietary,omitempty"`
}

Offers different (coded) formats to describe a currency.

type CustomerRoute1Choice

type CustomerRoute1Choice struct {
	Code        *CustomerRoute1Code `json:"code,omitempty"`
	Proprietary string              `json:"proprietary,omitempty"`
}

Specifies the customer route of the message, either in coded or proprietary form.

type CustomerRoute1Code

type CustomerRoute1Code string

CustomerRoute1Code : > Specifies the customer route of the message. *`SWFT_swift`-Traffic exchanged with SWIFT. *`ITER_inter_customer_group`-Traffic exchanged between different institutions. *`ITRA_intra_customer_group`-Traffic exchanged within the same institution group of branches.

const (
	SWFT_SWIFT_CustomerRoute1Code                CustomerRoute1Code = "SWFT_swift"
	ITER_INTER_CUSTOMER_GROUP_CustomerRoute1Code CustomerRoute1Code = "ITER_inter_customer_group"
	ITRA_INTRA_CUSTOMER_GROUP_CustomerRoute1Code CustomerRoute1Code = "ITRA_intra_customer_group"
)

List of CustomerRoute1Code

type DeliveryStatus1Choice

type DeliveryStatus1Choice struct {
	Code        *DeliveryStatus2Code `json:"code,omitempty"`
	Proprietary string               `json:"proprietary,omitempty"`
}

Specifies the delivery status of a message, in coded or proprietary form.

type DeliveryStatus2Code

type DeliveryStatus2Code string

DeliveryStatus2Code : > Specifies the status of the delivery of a message, in coded form. *`ABRT_aborted`-Sending of message was aborted by sender. *`DLVR_delivered`-Message was delivered to receiver. *`NACK_nacked`-Message was not acknowledged by receiver. *`RFUS_refused_by_infrastructure`-Message was refused by the infrastructure (e.g. SWIFT)

const (
	ABRT_ABORTED_DeliveryStatus2Code                   DeliveryStatus2Code = "ABRT_aborted"
	DLVR_DELIVERED_DeliveryStatus2Code                 DeliveryStatus2Code = "DLVR_delivered"
	NACK_NACKED_DeliveryStatus2Code                    DeliveryStatus2Code = "NACK_nacked"
	RFUS_REFUSED_BY_INFRASTRUCTURE_DeliveryStatus2Code DeliveryStatus2Code = "RFUS_refused_by_infrastructure"
)

List of DeliveryStatus2Code

type ErrorSeverity3Code

type ErrorSeverity3Code string

ErrorSeverity3Code : A enum describing the severity of an error

const (
	FATAL_ErrorSeverity3Code     ErrorSeverity3Code = "Fatal"
	LOGIC_ErrorSeverity3Code     ErrorSeverity3Code = "Logic"
	TRANSIENT_ErrorSeverity3Code ErrorSeverity3Code = "Transient"
)

List of ErrorSeverity3Code

type GenericStatus1

type GenericStatus1 struct {
	Code        string              `json:"code"`
	Severity    *ErrorSeverity3Code `json:"severity"`
	Text        string              `json:"text"`
	UserMessage string              `json:"user_message,omitempty"`
	MoreInfo    string              `json:"more_info,omitempty"`
}

Specifies the generic status as a result of a method applied to a Resource.

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 GeoRoute1Choice

type GeoRoute1Choice struct {
	Code        *GeoRoute1Code `json:"code,omitempty"`
	Proprietary string         `json:"proprietary,omitempty"`
}

Specifies the geographical route of the message, either in coded or proprietary form.

type GeoRoute1Code

type GeoRoute1Code string

GeoRoute1Code : > Specifies information about the geographic route the message is following. *`DMST_domestic`-Sender and receiver of the information are in the same country. *`INTL_international`-Sender and Receiver in different countries or the location of at least one of them is unknown. *`SWFT_swift`-Message involving SWIFT.

const (
	DMST_DOMESTIC_GeoRoute1Code      GeoRoute1Code = "DMST_domestic"
	INTL_INTERNATIONAL_GeoRoute1Code GeoRoute1Code = "INTL_international"
	SWFT_SWIFT_GeoRoute1Code         GeoRoute1Code = "SWFT_swift"
)

List of GeoRoute1Code

type InlineResponse200

type InlineResponse200 struct {
	BankingData []BankingData1   `json:"banking_data"`
	Links       *PaginationLinks `json:"links,omitempty"`
}

type Market1Code

type Market1Code string

Market1Code : > Specifies the business market. *`PMTS_payments`-Specifies the payments market. *`TRFN_trade_finance`-Specifies the trade finance market. *`TREA_treasury`-Specifies the treasury market.

const (
	PMTS_PAYMENTS_Market1Code      Market1Code = "PMTS_payments"
	TRFN_TRADE_FINANCE_Market1Code Market1Code = "TRFN_trade_finance"
	TREA_TREASURY_Market1Code      Market1Code = "TREA_treasury"
)

List of Market1Code

type MessageType1Choice

type MessageType1Choice struct {
	Code        string `json:"code,omitempty"`
	Proprietary string `json:"proprietary,omitempty"`
}

Specifies the MessageDefinition in different types of format.

type OneOfCountryIdentification2Choice

type OneOfCountryIdentification2Choice struct {
}

type OneOfCurrencyDetails1Choice

type OneOfCurrencyDetails1Choice struct {
}

type OneOfCustomerRoute1Choice

type OneOfCustomerRoute1Choice struct {
}

type OneOfDeliveryStatus1Choice

type OneOfDeliveryStatus1Choice struct {
}

type OneOfGeoRoute1Choice

type OneOfGeoRoute1Choice struct {
}

type OneOfMessageType1Choice

type OneOfMessageType1Choice struct {
}

type OneOfPartyIdentification180Choice

type OneOfPartyIdentification180Choice struct {
}

type OneOfRegion1Choice

type OneOfRegion1Choice struct {
}
type PaginationLinks struct {
	// The URI to the current page in the response
	Self string `json:"self"`
	// The URI to the next page of response data
	Next string `json:"next,omitempty"`
	// The URI to the previous page of response data
	Previous string `json:"previous,omitempty"`
	// The URI to the first page in the response
	First string `json:"first,omitempty"`
	// The URI to the last page in the response
	Last string `json:"last,omitempty"`
}

Links to help to find the self, next, previous, first and last pages of the response

type PartyDetails1

type PartyDetails1 struct {
	Id      *PartyIdentification180Choice `json:"id"`
	Country *CountryIdentification2Choice `json:"country"`
	Region  *Region1Choice                `json:"region,omitempty"`
}

Specifies a party through a number of properties of that party.

type PartyIdentification180Choice

type PartyIdentification180Choice struct {
	AnyBic      string `json:"any_bic,omitempty"`
	Proprietary string `json:"proprietary,omitempty"`
}

Identification of a party using a BIC, a proprietary structure or another structure.

type ProprietaryCountryInformation1

type ProprietaryCountryInformation1 struct {
	Code   *ProprietaryGeoRegionInformation1Code `json:"code"`
	Legacy string                                `json:"legacy,omitempty"`
}

Identifies a country in a proprietary way.

type ProprietaryCurrency1Code

type ProprietaryCurrency1Code string

ProprietaryCurrency1Code : > Specifies a currency in a proprietary, coded form. *`NCFD_no_currency_and_value_found`-No currency and value found during recon. *`NTAV_not_available`-Information is not available. *`OTHR_other`-Other than an ISO 4217 currency code.

const (
	NCFD_NO_CURRENCY_AND_VALUE_FOUND_ProprietaryCurrency1Code ProprietaryCurrency1Code = "NCFD_no_currency_and_value_found"
	NTAV_NOT_AVAILABLE_ProprietaryCurrency1Code               ProprietaryCurrency1Code = "NTAV_not_available"
	OTHR_OTHER_ProprietaryCurrency1Code                       ProprietaryCurrency1Code = "OTHR_other"
)

List of ProprietaryCurrency1Code

type ProprietaryCurrencyInformation1

type ProprietaryCurrencyInformation1 struct {
	Code   *ProprietaryCurrency1Code `json:"code"`
	Legacy string                    `json:"legacy,omitempty"`
}

Identifies a currency in a proprietary way.

type ProprietaryGeoRegionInformation1

type ProprietaryGeoRegionInformation1 struct {
	Code   *ProprietaryGeoRegionInformation2Code `json:"code"`
	Legacy string                                `json:"legacy,omitempty"`
}

Specifies the geographical region in a proprietary format, using a code or a legacy structure.

type ProprietaryGeoRegionInformation1Code

type ProprietaryGeoRegionInformation1Code string

ProprietaryGeoRegionInformation1Code : > Contains information about a country or geographical region in a proprietary, coded form. *`BILA_bilaterally_agreed`-Bilaterally agreed. *`EPTY_empty_element`-Empty element. *`FREE_free_format`-Free format. *`GIMI_global_imi`-Global IMI *`INTI_international_instrument`-International Instrument. *`NOTA_not_available`-Not available. *`OTHR_other`-Other. *`SWFT_swift`-SWIFT *`TGT2_target2`-Target 2 *`TCKS_ticker_symbol`-Ticker Symbol

const (
	BILA_BILATERALLY_AGREED_ProprietaryGeoRegionInformation1Code       ProprietaryGeoRegionInformation1Code = "BILA_bilaterally_agreed"
	EPTY_EMPTY_ELEMENT_ProprietaryGeoRegionInformation1Code            ProprietaryGeoRegionInformation1Code = "EPTY_empty_element"
	FREE_FREE_FORMAT_ProprietaryGeoRegionInformation1Code              ProprietaryGeoRegionInformation1Code = "FREE_free_format"
	GIMI_GLOBAL_IMI_ProprietaryGeoRegionInformation1Code               ProprietaryGeoRegionInformation1Code = "GIMI_global_imi"
	INTI_INTERNATIONAL_INSTRUMENT_ProprietaryGeoRegionInformation1Code ProprietaryGeoRegionInformation1Code = "INTI_international_instrument"
	NOTA_NOT_AVAILABLE_ProprietaryGeoRegionInformation1Code            ProprietaryGeoRegionInformation1Code = "NOTA_not_available"
	OTHR_OTHER_ProprietaryGeoRegionInformation1Code                    ProprietaryGeoRegionInformation1Code = "OTHR_other"
	SWFT_SWIFT_ProprietaryGeoRegionInformation1Code                    ProprietaryGeoRegionInformation1Code = "SWFT_swift"
	TGT2_TARGET2_ProprietaryGeoRegionInformation1Code                  ProprietaryGeoRegionInformation1Code = "TGT2_target2"
	TCKS_TICKER_SYMBOL_ProprietaryGeoRegionInformation1Code            ProprietaryGeoRegionInformation1Code = "TCKS_ticker_symbol"
)

List of ProprietaryGeoRegionInformation1Code

type ProprietaryGeoRegionInformation2Code

type ProprietaryGeoRegionInformation2Code string

ProprietaryGeoRegionInformation2Code : > Contains information about a country or geographical region in a proprietary, coded form. *`IMIR_imi_and_related_copies`-IMI and related copies. *`NOTA_not_available`-Not available. *`OTHR_other`-Other. *`SWFT_swift`-SWIFT

const (
	IMIR_IMI_AND_RELATED_COPIES_ProprietaryGeoRegionInformation2Code ProprietaryGeoRegionInformation2Code = "IMIR_imi_and_related_copies"
	NOTA_NOT_AVAILABLE_ProprietaryGeoRegionInformation2Code          ProprietaryGeoRegionInformation2Code = "NOTA_not_available"
	OTHR_OTHER_ProprietaryGeoRegionInformation2Code                  ProprietaryGeoRegionInformation2Code = "OTHR_other"
	SWFT_SWIFT_ProprietaryGeoRegionInformation2Code                  ProprietaryGeoRegionInformation2Code = "SWFT_swift"
)

List of ProprietaryGeoRegionInformation2Code

type Region1Choice

type Region1Choice struct {
	Code        *Region1Code                      `json:"code,omitempty"`
	Proprietary *ProprietaryGeoRegionInformation1 `json:"proprietary,omitempty"`
}

Specifies the region in various ways.

type Region1Code

type Region1Code string

Region1Code : > Specifies the geographical region, in coded form. *`AFRC_africa`-African region. *`APAC_asia_pacific`-Asia-Pacific region. *`CLAM_central_and_latin_america`-Central and Latin-American region. *`EURO_euro_zone`-Region of European countries that use the Euro currency. *`MDEA_middle_east`-Middle eastern region. *`NEUR_non_euro_zone`-Region of European countries that don't use the Euro currency. *`NOAM_north_america`-North American region.

const (
	AFRC_AFRICA_Region1Code                    Region1Code = "AFRC_africa"
	APAC_ASIA_PACIFIC_Region1Code              Region1Code = "APAC_asia_pacific"
	CLAM_CENTRAL_AND_LATIN_AMERICA_Region1Code Region1Code = "CLAM_central_and_latin_america"
	EURO_EURO_ZONE_Region1Code                 Region1Code = "EURO_euro_zone"
	MDEA_MIDDLE_EAST_Region1Code               Region1Code = "MDEA_middle_east"
	NEUR_NON_EURO_ZONE_Region1Code             Region1Code = "NEUR_non_euro_zone"
	NOAM_NORTH_AMERICA_Region1Code             Region1Code = "NOAM_north_america"
)

List of Region1Code

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL