CustomersApi.md

\CustomersApi

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

Method	HTTP request	Description
AddCustomerAddress	Post /customers/{customerID}/address	Add Customer Address
CreateCustomer	Post /customers	Create Customer
DeleteCustomer	Delete /customers/{customerID}	Delete Customer
DeleteCustomerAddress	Delete /customers/{customerID}/addresses/{addressID}	Delete Customer Address
GetCustomer	Get /customers/{customerID}	Get Customer
GetLatestOFACSearch	Get /customers/{customerID}/ofac	Latest Customer OFAC search
Ping	Get /ping	Ping Customers Service
RefreshOFACSearch	Put /customers/{customerID}/refresh/ofac	Refresh Customer OFAC search
ReplaceCustomerMetadata	Put /customers/{customerID}/metadata	Update Customer Metadata
SearchCustomers	Get /customers	Search Customers
UpdateCustomer	Put /customers/{customerID}	Update Customer
UpdateCustomerAddress	Put /customers/{customerID}/addresses/{addressID}	Update Customer Address
UpdateCustomerStatus	Put /customers/{customerID}/status	Update Customer Status

AddCustomerAddress

Customer AddCustomerAddress(ctx, customerID, createCustomerAddress, optional)

Add Customer Address

Add an Address onto an existing Customer record

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	customerID of the Customer to add the address onto
createCustomerAddress	CreateCustomerAddress
optional	*AddCustomerAddressOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a AddCustomerAddressOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

Customer

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateCustomer

Customer CreateCustomer(ctx, createCustomer, optional)

Create Customer

Create a Customer object from the given details of a human or business

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
createCustomer	CreateCustomer
optional	*CreateCustomerOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateCustomerOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

Customer

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCustomer

DeleteCustomer(ctx, customerID, optional)

Delete Customer

Remove a given Customer

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	customerID of the Customer to be deleted
optional	*DeleteCustomerOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCustomerOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteCustomerAddress

DeleteCustomerAddress(ctx, customerID, addressID)

Delete Customer Address

Deletes a customer's address

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	Customer ID
addressID	string	Address ID

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCustomer

Customer GetCustomer(ctx, customerID, optional)

Get Customer

Retrieve the Customer object and metadata for the customerID.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	customerID that identifies this Customer
optional	*GetCustomerOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCustomerOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

Customer

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLatestOFACSearch

OfacSearch GetLatestOFACSearch(ctx, customerID, optional)

Latest Customer OFAC search

Get the latest OFAC search for a Customer

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	customerID of the Customer to get latest OFAC search
optional	*GetLatestOFACSearchOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetLatestOFACSearchOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

OfacSearch

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Ping

Ping(ctx, )

Ping Customers Service

Check the Customers service to check if running

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RefreshOFACSearch

OfacSearch RefreshOFACSearch(ctx, customerID, optional)

Refresh Customer OFAC search

Refresh OFAC search for a given Customer

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	customerID of the Customer to refresh OFAC search
optional	*RefreshOFACSearchOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a RefreshOFACSearchOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

OfacSearch

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ReplaceCustomerMetadata

Customer ReplaceCustomerMetadata(ctx, customerID, customerMetadata, optional)

Update Customer Metadata

Replace the metadata object for a customer. Metadata is a map of unique keys associated to values to act as foreign key relationships or arbitrary data associated to a Customer.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	customerID of the Customer to add the metadata onto
customerMetadata	CustomerMetadata
optional	*ReplaceCustomerMetadataOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ReplaceCustomerMetadataOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

Customer

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchCustomers

[]Customer SearchCustomers(ctx, optional)

Search Customers

Search for customers using different filter parameters

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*SearchCustomersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SearchCustomersOpts struct

Name	Type	Description	Notes
query	optional.String	Optional parameter for searching by customer name
email	optional.String	Optional parameter for searching by customer email
status	optional.String	Optional parameter for searching by customer status
type_	optional.String	Optional parameter for searching by customer type
skip	optional.String	Optional parameter for searching for customers by skipping over an initial group
count	optional.String	Optional parameter for searching by specifying the amount to return
customerIDs	optional.String	Optional parameter for searching by customers' IDs

Return type

[]Customer

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCustomer

Customer UpdateCustomer(ctx, customerID, createCustomer, optional)

Update Customer

Update a Customer object

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	customerID that identifies this Customer
createCustomer	CreateCustomer
optional	*UpdateCustomerOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateCustomerOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

Customer

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCustomerAddress

UpdateCustomerAddress(ctx, customerID, addressID, updateCustomerAddress)

Update Customer Address

Updates the specified customer address

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	Customer ID
addressID	string	Address ID
updateCustomerAddress	UpdateCustomerAddress

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateCustomerStatus

Customer UpdateCustomerStatus(ctx, customerID, updateCustomerStatus, optional)

Update Customer Status

Update the status for a customer, which can only be updated by authenticated users with permissions.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerID	string	customerID of the Customer to update the CustomerStatus
updateCustomerStatus	UpdateCustomerStatus
optional	*UpdateCustomerStatusOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a UpdateCustomerStatusOpts struct

Name	Type	Description	Notes

xRequestID | optional.String| Optional requestID allows application developer to trace requests through the systems logs | xOrganization | optional.String| Value used to separate and identify models |

Return type

Customer

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]