Module godaddy.agreements
ballerinax/godaddy.agreements Ballerina library
Overview
This is a generated connector for GoDaddy Agreements API v1 OpenAPI specification.
The GoDaddy Agreements API provides capability to access GoDaddy operations related to agreements.
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.agreements: Client
This is a generated connector for GoDaddy Agreements API v1 OpenAPI specification. The GoDaddy Agreements API provides capability to access GoDaddy operations related to agreements.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a GoDaddy 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
getLegalAgreements
function getLegalAgreements(string[] keys, int? xPrivateLabelId, string xMarketId) returns LegalAgreement[]|errorRetrieve Legal Agreements for provided agreements keys
Parameters
- keys string[] - Keys for Agreements whose details are to be retrieved
- xPrivateLabelId int? (default ()) - PrivateLabelId to operate as, if different from JWT
- xMarketId string (default "en-US") - Unique identifier of the Market used to retrieve/translate Legal Agreements
Return Type
- LegalAgreement[]|error - Request was successful
Records
godaddy.agreements: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
godaddy.agreements: 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.agreements: 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.agreements: 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.agreements: LegalAgreement
Fields
- agreementKey string - Unique identifier for the legal agreement
- content string - Contents of the legal agreement, suitable for embedding
- title string - Title of the legal agreement
- url string? - URL to a page containing the legal agreement