Note: There is a newer version (0.2.1) of this package available. Click here to view docs for the latest version.
Module candid.charitycheckpdf
ballerinax/candid.charitycheckpdf Ballerina library
0.0.1
Clients
candid.charitycheckpdf: Client
Isolated
This end-point will allow you to retrieve organization's Charity Check information in PDF format. API returns the byte stream.
Constructor
Gets invoked to initialize the connector.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://apidata.guidestar.org/charitycheckpdf" - URL of the target service
get v1/pdf/[string ein]
Isolated FunctionResource Function
/charitycheckpdf/v1/pdf
Records
candid.charitycheckpdf: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- subscriptionKey string -
candid.charitycheckpdf: BadRequest
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
candid.charitycheckpdf: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
candid.charitycheckpdf: Forbidden
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: InternalServerError
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: NotAcceptable
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: NotFound
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
candid.charitycheckpdf: TooManyRequests
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status
candid.charitycheckpdf: Unauthorized
Fields
- code string? - HTTP response status code.
- message string? - Diagnostic message for response status