Documentation
¶
Index ¶
- type Client
- func (c *Client) CreateSession(sessionSpec *create.SessionSpecification) (*create.SessionResult, error)
- func (c *Client) DeleteMediaContent(sessionID, mediaID string) error
- func (c *Client) DeleteSession(sessionID string) error
- func (c *Client) GetMediaContent(sessionID, mediaID string) (media.Media, error)
- func (c *Client) GetSession(sessionID string) (*retrieve.GetSessionResult, error)
- func (c *Client) GetSupportedDocuments() (*supported.DocumentsResponse, error)
- func (c *Client) GetSupportedDocumentsWithNonLatin(includeNonLatin bool) (*supported.DocumentsResponse, error)
- func (c *Client) OverrideAPIURL(apiURL string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// SDK ID. This can be found in the Yoti Hub after you have created and activated an application.
SdkID string
// Private Key associated for your application, can be downloaded from the Yoti Hub.
Key *rsa.PrivateKey
// Mockable HTTP Client Interface
HTTPClient requests.HttpClient
// contains filtered or unexported fields
}
Client is responsible for setting up test data in the sandbox instance.
func (*Client) CreateSession ¶
func (c *Client) CreateSession(sessionSpec *create.SessionSpecification) (*create.SessionResult, error)
CreateSession creates a Doc Scan (IDV) session using the supplied session specification
func (*Client) DeleteMediaContent ¶
DeleteMediaContent deletes media related to a Yoti Doc Scan (IDV) session based on the supplied media ID
func (*Client) DeleteSession ¶
DeleteSession deletes a previously created Yoti Doc Scan (IDV) session and all of its related resources
func (*Client) GetMediaContent ¶
GetMediaContent retrieves media related to a Yoti Doc Scan (IDV) session based on the supplied media ID
func (*Client) GetSession ¶
func (c *Client) GetSession(sessionID string) (*retrieve.GetSessionResult, error)
GetSession retrieves the state of a previously created Yoti Doc Scan (IDV) session
func (*Client) GetSupportedDocuments ¶
func (c *Client) GetSupportedDocuments() (*supported.DocumentsResponse, error)
GetSupportedDocuments gets a slice of supported documents (defaults includeNonLatin to false)
func (*Client) GetSupportedDocumentsWithNonLatin ¶ added in v3.9.0
func (c *Client) GetSupportedDocumentsWithNonLatin(includeNonLatin bool) (*supported.DocumentsResponse, error)
GetSupportedDocuments gets a slice of supported documents with bool param includeNonLatin
func (*Client) OverrideAPIURL ¶
OverrideAPIURL overrides the default API URL for this Yoti Client
Source Files
Directories