Module godaddy.aftermarket
ballerinax/godaddy.aftermarket Ballerina library
Overview
This is a generated connector for GoDaddy Aftermarket API v1 OpenAPI specification.
The GoDaddy Aftermarkets API provides capability to access GoDaddy operations related to auctions.
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
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, ClientConfiguration clientConfig, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.ote-godaddy.com/" - URL of the target service
deleteListings
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
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
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
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 float? -