client

package
v0.21.5 Latest Latest
Warning

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

 Go to latest Published: Apr 4, 2022 License: Apache-2.0 Imports: 23 Imported by: 2

README

Go API client for client

Moov Watchman offers download, parse, and search functions over numerous U.S. trade sanction lists for complying with regional laws. Also included is a web UI and async webhook notification service to initiate processes on remote systems.

Overview

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

  • API version: v1
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://github.com/moov-io/watchman

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

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

import "./client"

Documentation for API Endpoints

All URIs are relative to http://localhost:8084

Class Method HTTP request Description
WatchmanApi AddOfacCompanyNameWatch Post /ofac/companies/watch Watch company
WatchmanApi AddOfacCompanyWatch Post /ofac/companies/{companyID}/watch Watch OFAC company
WatchmanApi AddOfacCustomerNameWatch Post /ofac/customers/watch Watch customer
WatchmanApi AddOfacCustomerWatch Post /ofac/customers/{customerID}/watch Watch OFAC customer
WatchmanApi GetLatestDownloads Get /downloads Get latest downloads
WatchmanApi GetOfacCompany Get /ofac/companies/{companyID} Get company
WatchmanApi GetOfacCustomer Get /ofac/customers/{customerID} Get customer
WatchmanApi GetSDN Get /ofac/sdn/{sdnID} Get SDN
WatchmanApi GetSDNAddresses Get /ofac/sdn/{sdnID}/addresses Get SDN addresses
WatchmanApi GetSDNAltNames Get /ofac/sdn/{sdnID}/alts Get SDN alt names
WatchmanApi GetUIValues Get /ui/values/{key} Get UI values
WatchmanApi Ping Get /ping Ping Watchman service
WatchmanApi RemoveOfacCompanyNameWatch Delete /ofac/companies/watch/{watchID} Remove company watch
WatchmanApi RemoveOfacCompanyWatch Delete /ofac/companies/{companyID}/watch/{watchID} Remove company watch
WatchmanApi RemoveOfacCustomerNameWatch Delete /ofac/customers/watch/{watchID} Remove customer watch
WatchmanApi RemoveOfacCustomerWatch Delete /ofac/customers/{customerID}/watch/{watchID} Remove customer watch
WatchmanApi Search Get /search Search SDNs
WatchmanApi UpdateOfacCompanyStatus Put /ofac/companies/{companyID} Update company
WatchmanApi UpdateOfacCustomerStatus Put /ofac/customers/{customerID} Update customer

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an 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 {
	WatchmanApi *WatchmanApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Watchman API API vv1 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)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

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 OpenAPI 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:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AddOfacCompanyNameWatchOpts 

type AddOfacCompanyNameWatchOpts struct {
	XRequestID optional.String
}

AddOfacCompanyNameWatchOpts Optional parameters for the method 'AddOfacCompanyNameWatch'

type AddOfacCompanyWatchOpts 

type AddOfacCompanyWatchOpts struct {
	XRequestID optional.String
}

AddOfacCompanyWatchOpts Optional parameters for the method 'AddOfacCompanyWatch'

type AddOfacCustomerNameWatchOpts 

type AddOfacCustomerNameWatchOpts struct {
	XRequestID optional.String
}

AddOfacCustomerNameWatchOpts Optional parameters for the method 'AddOfacCustomerNameWatch'

type AddOfacCustomerWatchOpts 

type AddOfacCustomerWatchOpts struct {
	XRequestID optional.String
}

AddOfacCustomerWatchOpts Optional parameters for the method 'AddOfacCustomerWatch'

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 BisEntities 

type BisEntities struct {
	// The name of the entity
	Name string `json:"name,omitempty"`
	// Addresses associated with the entity
	Addresses []string `json:"addresses,omitempty"`
	// Known aliases associated with the entity
	AlternateNames []string `json:"alternateNames,omitempty"`
	// Date when the restriction came into effect
	StartDate string `json:"startDate,omitempty"`
	// Specifies the license requirement imposed on the named entity
	LicenseRequirement string `json:"licenseRequirement,omitempty"`
	// Identifies the policy BIS uses to review the licenseRequirements
	LicensePolicy string `json:"licensePolicy,omitempty"`
	// Identifies the corresponding Notice in the Federal Register
	FrNotice string `json:"frNotice,omitempty"`
	// The link to the official SSI list
	SourceListURL string `json:"sourceListURL,omitempty"`
	// The link for information regarding the source
	SourceInfoURL string `json:"sourceInfoURL,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
}

BisEntities Bureau of Industry and Security Entity List

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"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl added in v0.14.0 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type Download 

type Download struct {
	SDNs              int32     `json:"SDNs,omitempty"`
	AltNames          int32     `json:"altNames,omitempty"`
	Addresses         int32     `json:"addresses,omitempty"`
	SectoralSanctions int32     `json:"sectoralSanctions,omitempty"`
	DeniedPersons     int32     `json:"deniedPersons,omitempty"`
	BisEntities       int32     `json:"bisEntities,omitempty"`
	Timestamp         time.Time `json:"timestamp,omitempty"`
}

Download Metadata and stats about downloaded OFAC data

type Dpl 

type Dpl struct {
	// Denied Person's name
	Name string `json:"name,omitempty"`
	// Denied Person's street address
	StreetAddress string `json:"streetAddress,omitempty"`
	// Denied Person's city
	City string `json:"city,omitempty"`
	// Denied Person's state
	State string `json:"state,omitempty"`
	// Denied Person's country
	Country string `json:"country,omitempty"`
	// Denied Person's postal code
	PostalCode string `json:"postalCode,omitempty"`
	// Date when denial came into effect
	EffectiveDate string `json:"effectiveDate,omitempty"`
	// Date when denial expires, if blank denial never expires
	ExpirationDate string `json:"expirationDate,omitempty"`
	// Denotes whether or not the Denied Person was added by a standard order
	StandardOrder string `json:"standardOrder,omitempty"`
	// Date when the Denied Person's record was most recently updated
	LastUpdate string `json:"lastUpdate,omitempty"`
	// Most recent action taken regarding the denial
	Action string `json:"action,omitempty"`
	// Reference to the order's citation in the Federal Register
	FrCitation string `json:"frCitation,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
}

Dpl BIS Denied Persons List item

type Error 

type Error struct {
	// An error message describing the problem intended for humans.
	Error string `json:"error"`
}

Error struct for Error

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GetLatestDownloadsOpts 

type GetLatestDownloadsOpts struct {
	XRequestID optional.String
	Limit      optional.Int32
}

GetLatestDownloadsOpts Optional parameters for the method 'GetLatestDownloads'

type GetOfacCompanyOpts 

type GetOfacCompanyOpts struct {
	XRequestID optional.String
}

GetOfacCompanyOpts Optional parameters for the method 'GetOfacCompany'

type GetOfacCustomerOpts 

type GetOfacCustomerOpts struct {
	XRequestID optional.String
}

GetOfacCustomerOpts Optional parameters for the method 'GetOfacCustomer'

type GetSDNAddressesOpts 

type GetSDNAddressesOpts struct {
	XRequestID optional.String
}

GetSDNAddressesOpts Optional parameters for the method 'GetSDNAddresses'

type GetSDNAltNamesOpts 

type GetSDNAltNamesOpts struct {
	XRequestID optional.String
}

GetSDNAltNamesOpts Optional parameters for the method 'GetSDNAltNames'

type GetSDNOpts 

type GetSDNOpts struct {
	XRequestID optional.String
}

GetSDNOpts Optional parameters for the method 'GetSDN'

type GetUIValuesOpts 

type GetUIValuesOpts struct {
	Limit optional.Int32
}

GetUIValuesOpts Optional parameters for the method 'GetUIValues'

type OfacAlt 

type OfacAlt struct {
	EntityID         string `json:"entityID,omitempty"`
	AlternateID      string `json:"alternateID,omitempty"`
	AlternateType    string `json:"alternateType,omitempty"`
	AlternateName    string `json:"alternateName,omitempty"`
	AlternateRemarks string `json:"alternateRemarks,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
}

OfacAlt Alternate name from OFAC list

type OfacCompany 

type OfacCompany struct {
	// OFAC Company ID
	ID        string              `json:"ID,omitempty"`
	Sdn       OfacSdn             `json:"sdn,omitempty"`
	Addresses []OfacEntityAddress `json:"addresses,omitempty"`
	Alts      []OfacAlt           `json:"alts,omitempty"`
	Status    OfacCompanyStatus   `json:"status,omitempty"`
}

OfacCompany OFAC Company and metadata

type OfacCompanyStatus 

type OfacCompanyStatus struct {
	// User ID provided when updating status
	UserID string `json:"userID,omitempty"`
	// Optional note from updating status
	Note string `json:"note,omitempty"`
	// Manually applied status for OFAC Company
	Status    string    `json:"status,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
}

OfacCompanyStatus Status properties of an OFAC Company

type OfacCustomer 

type OfacCustomer struct {
	// OFAC Customer ID
	ID        string              `json:"ID,omitempty"`
	Sdn       OfacSdn             `json:"sdn,omitempty"`
	Addresses []OfacEntityAddress `json:"addresses,omitempty"`
	Alts      []OfacAlt           `json:"alts,omitempty"`
	Status    OfacCustomerStatus  `json:"status,omitempty"`
}

OfacCustomer OFAC Customer and metadata

type OfacCustomerStatus 

type OfacCustomerStatus struct {
	// User ID provided when updating status
	UserID string `json:"userID,omitempty"`
	// Optional note from updating status
	Note string `json:"note,omitempty"`
	// Manually applied status for OFAC Customer
	Status    string    `json:"status,omitempty"`
	CreatedAt time.Time `json:"createdAt,omitempty"`
}

OfacCustomerStatus Status properties of an OFAC Customer

type OfacEntityAddress 

type OfacEntityAddress struct {
	EntityID                    string `json:"entityID,omitempty"`
	AddressID                   string `json:"addressID,omitempty"`
	Address                     string `json:"address,omitempty"`
	CityStateProvincePostalCode string `json:"cityStateProvincePostalCode,omitempty"`
	Country                     string `json:"country,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
}

OfacEntityAddress Physical address from OFAC list

type OfacSdn 

type OfacSdn struct {
	EntityID string  `json:"entityID,omitempty"`
	SdnName  string  `json:"sdnName,omitempty"`
	SdnType  SdnType `json:"sdnType,omitempty"`
	// Programs is the sanction programs this SDN was added from
	Programs []string `json:"programs,omitempty"`
	Title    string   `json:"title,omitempty"`
	// Remarks on SDN and often additional information about the SDN
	Remarks string `json:"remarks,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
}

OfacSdn Specially designated national from OFAC list

type OfacWatch 

type OfacWatch struct {
	// Object representing a customer or company watch
	WatchID string `json:"watchID,omitempty"`
}

OfacWatch Customer or Company watch

type OfacWatchRequest 

type OfacWatchRequest struct {
	// Private token supplied by clients to be used for authenticating webhooks.
	AuthToken string `json:"authToken"`
	// HTTPS url for webhook on search match
	Webhook string `json:"webhook"`
}

OfacWatchRequest Webhook or other means of notification on search criteria. OFAC will make a POST request with a body of the customer or company (SDN, AltNames, and Address).

type RemoveOfacCompanyNameWatchOpts 

type RemoveOfacCompanyNameWatchOpts struct {
	XRequestID optional.String
}

RemoveOfacCompanyNameWatchOpts Optional parameters for the method 'RemoveOfacCompanyNameWatch'

type RemoveOfacCompanyWatchOpts 

type RemoveOfacCompanyWatchOpts struct {
	XRequestID optional.String
}

RemoveOfacCompanyWatchOpts Optional parameters for the method 'RemoveOfacCompanyWatch'

type RemoveOfacCustomerNameWatchOpts 

type RemoveOfacCustomerNameWatchOpts struct {
	XRequestID optional.String
}

RemoveOfacCustomerNameWatchOpts Optional parameters for the method 'RemoveOfacCustomerNameWatch'

type RemoveOfacCustomerWatchOpts 

type RemoveOfacCustomerWatchOpts struct {
	XRequestID optional.String
}

RemoveOfacCustomerWatchOpts Optional parameters for the method 'RemoveOfacCustomerWatch'

type SdnType added in v0.16.0 

type SdnType string

SdnType Used for classifying SDNs — typically represents an individual or company 

const (
	SDNTYPE_INDIVIDUAL SdnType = "individual"
	SDNTYPE_ENTITY     SdnType = "entity"
	SDNTYPE_VESSEL     SdnType = "vessel"
	SDNTYPE_AIRCRAFT   SdnType = "aircraft"
)

List of SdnType 

type Search struct {
	SDNs              []OfacSdn           `json:"SDNs,omitempty"`
	AltNames          []OfacAlt           `json:"altNames,omitempty"`
	Addresses         []OfacEntityAddress `json:"addresses,omitempty"`
	SectoralSanctions []Ssi               `json:"sectoralSanctions,omitempty"`
	DeniedPersons     []Dpl               `json:"deniedPersons,omitempty"`
	BisEntities       []BisEntities       `json:"bisEntities,omitempty"`
	RefreshedAt       time.Time           `json:"refreshedAt,omitempty"`
}

Search Search results containing SDNs, alternate names, and/or addreses

type SearchOpts 

type SearchOpts struct {
	XRequestID optional.String
	Q          optional.String
	Name       optional.String
	Address    optional.String
	City       optional.String
	State      optional.String
	Providence optional.String
	Zip        optional.String
	Country    optional.String
	AltName    optional.String
	Id         optional.String
	MinMatch   optional.Float32
	Limit      optional.Int32
	SdnType    optional.String
	Program    optional.String
}

SearchOpts Optional parameters for the method 'Search'

type ServerConfiguration added in v0.14.0 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable added in v0.14.0 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type Ssi 

type Ssi struct {
	// The ID assigned to an entity by the Treasury Department
	EntityID string  `json:"entityID,omitempty"`
	Type     SsiType `json:"type,omitempty"`
	// Sanction programs for which the entity is flagged
	Programs []string `json:"programs,omitempty"`
	// The name of the entity
	Name string `json:"name,omitempty"`
	// Addresses associated with the entity
	Addresses []string `json:"addresses,omitempty"`
	// Additional details regarding the entity
	Remarks []string `json:"remarks,omitempty"`
	// Known aliases associated with the entity
	AlternateNames []string `json:"alternateNames,omitempty"`
	// IDs on file for the entity
	Ids []string `json:"ids,omitempty"`
	// The link to the official SSI list
	SourceListURL string `json:"sourceListURL,omitempty"`
	// The link for information regarding the source
	SourceInfoURL string `json:"sourceInfoURL,omitempty"`
	// Match percentage of search query
	Match float32 `json:"match,omitempty"`
}

Ssi Treasury Department Sectoral Sanctions Identifications List (SSI)

type SsiType added in v0.16.0 

type SsiType string

SsiType Used for classifying SSIs 

const (
	SSITYPE_INDIVIDUAL SsiType = "individual"
	SSITYPE_ENTITY     SsiType = "entity"
)

List of SsiType

type UpdateOfacCompanyStatus 

type UpdateOfacCompanyStatus struct {
	// Manual override of company/SDN sanction status
	Status string `json:"status"`
	// Free form notes about manually changing the Company status
	Notes string `json:"notes,omitempty"`
}

UpdateOfacCompanyStatus Request body to update a company status.

type UpdateOfacCompanyStatusOpts 

type UpdateOfacCompanyStatusOpts struct {
	XRequestID optional.String
	XUserID    optional.String
}

UpdateOfacCompanyStatusOpts Optional parameters for the method 'UpdateOfacCompanyStatus'

type UpdateOfacCustomerStatus 

type UpdateOfacCustomerStatus struct {
	// Manual override of customer/SDN sanction status
	Status string `json:"status"`
	// Free form notes about manually changing the Customer status
	Notes string `json:"notes,omitempty"`
}

UpdateOfacCustomerStatus Request body to update a customers status.

type UpdateOfacCustomerStatusOpts 

type UpdateOfacCustomerStatusOpts struct {
	XRequestID optional.String
	XUserID    optional.String
}

UpdateOfacCustomerStatusOpts Optional parameters for the method 'UpdateOfacCustomerStatus'

type WatchmanApiService 

type WatchmanApiService service

WatchmanApiService WatchmanApi service

func (*WatchmanApiService) AddOfacCompanyNameWatch 

func (a *WatchmanApiService) AddOfacCompanyNameWatch(ctx _context.Context, name string, ofacWatchRequest OfacWatchRequest, localVarOptionals *AddOfacCompanyNameWatchOpts) (OfacWatch, *_nethttp.Response, error)

AddOfacCompanyNameWatch Watch company Watch a company by its name. The match percentage will be included in the webhook's JSON payload.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name Company name used to match and send watch notifications
  • @param ofacWatchRequest
  • @param optional nil or *AddOfacCompanyNameWatchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return OfacWatch

func (*WatchmanApiService) AddOfacCompanyWatch 

func (a *WatchmanApiService) AddOfacCompanyWatch(ctx _context.Context, companyID string, ofacWatchRequest OfacWatchRequest, localVarOptionals *AddOfacCompanyWatchOpts) (OfacWatch, *_nethttp.Response, error)

AddOfacCompanyWatch Watch OFAC company Add ID watch on an OFAC Company.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param companyID Company ID
  • @param ofacWatchRequest
  • @param optional nil or *AddOfacCompanyWatchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return OfacWatch

func (*WatchmanApiService) AddOfacCustomerNameWatch 

func (a *WatchmanApiService) AddOfacCustomerNameWatch(ctx _context.Context, name string, ofacWatchRequest OfacWatchRequest, localVarOptionals *AddOfacCustomerNameWatchOpts) (OfacWatch, *_nethttp.Response, error)

AddOfacCustomerNameWatch Watch customer Watch a customer by its name. The match percentage will be included in the webhook's JSON payload.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name Individual name used to match and send watch notifications
  • @param ofacWatchRequest
  • @param optional nil or *AddOfacCustomerNameWatchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return OfacWatch

func (*WatchmanApiService) AddOfacCustomerWatch 

func (a *WatchmanApiService) AddOfacCustomerWatch(ctx _context.Context, customerID string, ofacWatchRequest OfacWatchRequest, localVarOptionals *AddOfacCustomerWatchOpts) (OfacWatch, *_nethttp.Response, error)

AddOfacCustomerWatch Watch OFAC customer Add ID watch on an OFAC Customer.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID Customer ID
  • @param ofacWatchRequest
  • @param optional nil or *AddOfacCustomerWatchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return OfacWatch

func (*WatchmanApiService) GetLatestDownloads 

func (a *WatchmanApiService) GetLatestDownloads(ctx _context.Context, localVarOptionals *GetLatestDownloadsOpts) ([]Download, *_nethttp.Response, error)

GetLatestDownloads Get latest downloads Return list of recent downloads of list data.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GetLatestDownloadsOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "Limit" (optional.Int32) - Maximum number of downloads to return sorted by their timestamp in decending order.

@return []Download

func (*WatchmanApiService) GetOfacCompany 

func (a *WatchmanApiService) GetOfacCompany(ctx _context.Context, companyID string, localVarOptionals *GetOfacCompanyOpts) (OfacCompany, *_nethttp.Response, error)

GetOfacCompany Get company Get information about a company, trust, or organization such as addresses, alternate names, and remarks.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param companyID Company ID
  • @param optional nil or *GetOfacCompanyOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return OfacCompany

func (*WatchmanApiService) GetOfacCustomer 

func (a *WatchmanApiService) GetOfacCustomer(ctx _context.Context, customerID string, localVarOptionals *GetOfacCustomerOpts) (OfacCustomer, *_nethttp.Response, error)

GetOfacCustomer Get customer Get information about a customer's addresses, alternate names, and SDN metadata.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID Customer ID
  • @param optional nil or *GetOfacCustomerOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return OfacCustomer

func (*WatchmanApiService) GetSDN 

func (a *WatchmanApiService) GetSDN(ctx _context.Context, sdnID string, localVarOptionals *GetSDNOpts) (OfacSdn, *_nethttp.Response, error)

GetSDN Get SDN Get SDN details

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sdnID SDN ID
  • @param optional nil or *GetSDNOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return OfacSdn

func (*WatchmanApiService) GetSDNAddresses 

func (a *WatchmanApiService) GetSDNAddresses(ctx _context.Context, sdnID string, localVarOptionals *GetSDNAddressesOpts) ([]OfacEntityAddress, *_nethttp.Response, error)

GetSDNAddresses Get SDN addresses

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sdnID SDN ID
  • @param optional nil or *GetSDNAddressesOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return []OfacEntityAddress

func (*WatchmanApiService) GetSDNAltNames 

func (a *WatchmanApiService) GetSDNAltNames(ctx _context.Context, sdnID string, localVarOptionals *GetSDNAltNamesOpts) ([]OfacAlt, *_nethttp.Response, error)

GetSDNAltNames Get SDN alt names

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sdnID SDN ID
  • @param optional nil or *GetSDNAltNamesOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

@return []OfacAlt

func (*WatchmanApiService) GetUIValues 

func (a *WatchmanApiService) GetUIValues(ctx _context.Context, key string, localVarOptionals *GetUIValuesOpts) ([]SdnType, *_nethttp.Response, error)

GetUIValues Get UI values Return an ordered distinct list of keys for an SDN property.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param key SDN property to lookup. Values are sdnType, ofacProgram
  • @param optional nil or *GetUIValuesOpts - Optional Parameters:
  • @param "Limit" (optional.Int32) - Maximum number of UI keys returned

@return []SdnType

func (*WatchmanApiService) Ping 

func (a *WatchmanApiService) Ping(ctx _context.Context) (*_nethttp.Response, error)

Ping Ping Watchman service Check if the Watchman service is running.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*WatchmanApiService) RemoveOfacCompanyNameWatch 

func (a *WatchmanApiService) RemoveOfacCompanyNameWatch(ctx _context.Context, watchID string, name string, localVarOptionals *RemoveOfacCompanyNameWatchOpts) (*_nethttp.Response, error)

RemoveOfacCompanyNameWatch Remove company watch Delete a company name watch.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param watchID Watch ID, used to identify a specific watch
  • @param name Company name watch
  • @param optional nil or *RemoveOfacCompanyNameWatchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

func (*WatchmanApiService) RemoveOfacCompanyWatch 

func (a *WatchmanApiService) RemoveOfacCompanyWatch(ctx _context.Context, companyID string, watchID string, localVarOptionals *RemoveOfacCompanyWatchOpts) (*_nethttp.Response, error)

RemoveOfacCompanyWatch Remove company watch Delete a company ID watch.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param companyID Company ID
  • @param watchID Watch ID, used to identify a specific watch
  • @param optional nil or *RemoveOfacCompanyWatchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

func (*WatchmanApiService) RemoveOfacCustomerNameWatch 

func (a *WatchmanApiService) RemoveOfacCustomerNameWatch(ctx _context.Context, watchID string, name string, localVarOptionals *RemoveOfacCustomerNameWatchOpts) (*_nethttp.Response, error)

RemoveOfacCustomerNameWatch Remove customer watch Delete a customer name watch.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param watchID Watch ID, used to identify a specific watch
  • @param name Customer or Company name watch
  • @param optional nil or *RemoveOfacCustomerNameWatchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

func (*WatchmanApiService) RemoveOfacCustomerWatch 

func (a *WatchmanApiService) RemoveOfacCustomerWatch(ctx _context.Context, customerID string, watchID string, localVarOptionals *RemoveOfacCustomerWatchOpts) (*_nethttp.Response, error)

RemoveOfacCustomerWatch Remove customer watch Delete a customer ID watch.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID Customer ID
  • @param watchID Watch ID, used to identify a specific watch
  • @param optional nil or *RemoveOfacCustomerWatchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs

func (*WatchmanApiService) Search 

func (a *WatchmanApiService) Search(ctx _context.Context, localVarOptionals *SearchOpts) (Search, *_nethttp.Response, error)

Search Search SDNs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SearchOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "Q" (optional.String) - Search across Name, Alt Names, and SDN Address fields for all available sanctions lists. Entries may be returned in all response sub-objects.
  • @param "Name" (optional.String) - Name which could correspond to an entry on the SDN, Denied Persons, Sectoral Sanctions Identifications, or BIS Entity List sanctions lists. Alt names are also searched.
  • @param "Address" (optional.String) - Physical address which could correspond to a human on the SDN list. Only Address results will be returned.
  • @param "City" (optional.String) - City name as desginated by SDN guidelines. Only Address results will be returned.
  • @param "State" (optional.String) - State name as desginated by SDN guidelines. Only Address results will be returned.
  • @param "Providence" (optional.String) - Providence name as desginated by SDN guidelines. Only Address results will be returned.
  • @param "Zip" (optional.String) - Zip code as desginated by SDN guidelines. Only Address results will be returned.
  • @param "Country" (optional.String) - Country name as desginated by SDN guidelines. Only Address results will be returned.
  • @param "AltName" (optional.String) - Alternate name which could correspond to a human on the SDN list. Only Alt name results will be returned.
  • @param "Id" (optional.String) - ID value often found in remarks property of an SDN. Takes the form of 'No. NNNNN' as an alphanumeric value.
  • @param "MinMatch" (optional.Float32) - Match percentage that search query must obtain for results to be returned.
  • @param "Limit" (optional.Int32) - Maximum results returned by a search. Results are sorted by their match percentage in decending order.
  • @param "SdnType" (optional.String) - Optional filter to only return SDNs whose type case-insensitively matches.
  • @param "Program" (optional.String) - Optional filter to only return SDNs whose program case-insensitively matches.

@return Search

func (*WatchmanApiService) UpdateOfacCompanyStatus 

func (a *WatchmanApiService) UpdateOfacCompanyStatus(ctx _context.Context, companyID string, updateOfacCompanyStatus UpdateOfacCompanyStatus, localVarOptionals *UpdateOfacCompanyStatusOpts) (*_nethttp.Response, error)

UpdateOfacCompanyStatus Update company Update a Company's sanction status to always block or always allow transactions.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param companyID Company ID
  • @param updateOfacCompanyStatus
  • @param optional nil or *UpdateOfacCompanyStatusOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "XUserID" (optional.String) - User ID used to perform this search

func (*WatchmanApiService) UpdateOfacCustomerStatus 

func (a *WatchmanApiService) UpdateOfacCustomerStatus(ctx _context.Context, customerID string, updateOfacCustomerStatus UpdateOfacCustomerStatus, localVarOptionals *UpdateOfacCustomerStatusOpts) (*_nethttp.Response, error)

UpdateOfacCustomerStatus Update customer Update a Customer sanction status to always block or always allow transactions.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param customerID Customer ID
  • @param updateOfacCustomerStatus
  • @param optional nil or *UpdateOfacCustomerStatusOpts - Optional Parameters:
  • @param "XRequestID" (optional.String) - Optional Request ID allows application developer to trace requests through the system's logs
  • @param "XUserID" (optional.String) - User ID used to perform this search

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.