Module godaddy.aftermarket
ballerinax/godaddy.aftermarket Ballerina library
1.5.2
Overview
The GoDaddy Aftermarket API v1 connector(https://developer.godaddy.com/doc/endpoint/aftermarkets) OpenAPI specification.
The GoDaddy Aftermarkets API provides capability to access GoDaddy operations related to auctions.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create an GoDaddy account
- Obtain tokens
- Follow this link to obtain tokens
Clients
godaddy.aftermarket: Client
Isolated
This is a generated connector for GoDaddy Aftermarket API v1 OpenAPI specification. The GoDaddy Aftermarket API provides capability to access GoDaddy operations related to GoDaddy Auctions.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials. Create a GoDaddy Shoppers and obtain tokens by following this guide.
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://api.ote-godaddy.com/" - URL of the target service
deleteListings
Isolated FunctionRemote Function
function deleteListings(string[] domains) returns AftermarketListingAction|errorRemove listings from GoDaddy Auction
Parameters
- domains string[] - A comma separated list of domain names
Return Type
- AftermarketListingAction|error - Request was successful
addExpiryListings
Isolated FunctionRemote Function
function addExpiryListings(AftermarketListingExpiryCreate[] payload) returns AftermarketListingAction|errorAdd expiry listings into GoDaddy Auction
Parameters
- payload AftermarketListingExpiryCreate[] - An array of expiry listings to be loaded
Return Type
- AftermarketListingAction|error - Request was successful
Records
godaddy.aftermarket: AftermarketListingAction
Fields
- listingActionId int - Action Id
godaddy.aftermarket: AftermarketListingExpiryCreate
Fields
- domain string - Domain name
- expiresAt string - Date when the domain expires
- losingRegistrarId int - Losing registrar id for the domain
- pageViewsMonthly? int - Monthly traffic page view for the domain
- revenueMonthly? int - Monthly parking revenue (in USD micro unit) for the domain
godaddy.aftermarket: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
godaddy.aftermarket: 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
godaddy.aftermarket: 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
godaddy.aftermarket: Error
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields? ErrorField[] - List of the specific fields, and the errors found with their contents
- message? string - Human-readable, English description of the error
godaddy.aftermarket: ErrorField
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- message? string - Human-readable, English description of the problem with the contents of the field
- path string - <ul> <li style='margin-left: 12px;'>JSONPath referring to a field containing an error</li> <strong style='margin-left: 12px;'>OR</strong> <li style='margin-left: 12px;'>JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`</li> </ul>
- pathRelated? string - JSONPath referring to a field containing an error, which is referenced by
path
godaddy.aftermarket: ErrorLimit
Fields
- code string - Short identifier for the error, suitable for indicating the specific error within client code
- fields? ErrorField[] - List of the specific fields, and the errors found with their contents
- message? string - Human-readable, English description of the error
- retryAfterSec int - Number of seconds to wait before attempting a similar request
godaddy.aftermarket: Expiry
Fields
- id? decimal -
godaddy.aftermarket: 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