Ballerina library

godaddy.orders

Module godaddy.orders

OverviewPrerequisites

API

Client

Definitions

Address
ApiKeysConfig
BillTo
ClientHttp1Settings
ConnectionConfig
Contact
Error
ErrorField
ErrorLimit
LineItem
LineItemPricing
LineItemPricingTaxDetail
LineItemSummary
LineItemTaxCollector
LineItemUnitPricing
Order
OrderFee
OrderList
OrderPricing
OrderSummary
OrderSummaryPricing
Pagination
Payment
ProxyConfig

ballerinax/godaddy.orders Ballerina library

1.5.1

Overview

This is a generated connector for GoDaddy Orders API v1 OpenAPI specification.

The GoDaddy Orders API provides capability to access GoDaddy operations related to orders.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  • Create an GoDaddy account
  • Obtain tokens
    1. Follow this link to obtain tokens

Clients

godaddy.orders: Client

Isolated

This is a generated connector for GoDaddy Orders API v1 OpenAPI specification. The GoDaddy Orders API provides capability to access GoDaddy operations related to orders.

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, ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://api.ote-godaddy.com/" - URL of the target service

listOrders

Isolated FunctionRemote Function
function listOrders(string? periodStart, string? periodEnd, string? domain, int? productGroupId, int? paymentProfileId, string? parentOrderId, int offset, int 'limit, string sort, string? xShopperId, string xMarketId) returns OrderList|error

Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time

Parameters
  • periodStart string? (default ()) - Start of range indicating what time-frame should be returned. Inclusive
  • periodEnd string? (default ()) - End of range indicating what time-frame should be returned. Inclusive
  • domain string? (default ()) - Domain name to use as the filter of results
  • productGroupId int? (default ()) - Product group id to use as the filter of results
  • paymentProfileId int? (default ()) - Payment profile id to use as the filter of results
  • parentOrderId string? (default ()) - Parent order id to use as the filter of results
  • offset int (default 0) - Number of results to skip for pagination
  • 'limit int (default 25) - Maximum number of items to return
  • sort string (default "-createdAt") - Property name that will be used to sort results. '-' indicates descending
  • xShopperId string? (default ()) - Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>
  • xMarketId string (default "en-US") - Unique identifier of the Market in which the request is happening
Return Type

getOrderByID

Isolated FunctionRemote Function
function getOrderByID(string orderId, string? xShopperId, string xMarketId) returns Order|error

Retrieve details for specified order

Parameters
  • orderId string - Order id whose details are to be retrieved
  • xShopperId string? (default ()) - Shopper ID to be operated on, if different from JWT<br/><b>Reseller subaccounts are not supported</b>
  • xMarketId string (default "en-US") - Unique identifier of the Market in which the request is happening
Return Type

Records

godaddy.orders: Address

Fields
  • country string - Two-letter ISO country code to be used as a hint for target region<br/><br/> NOTE: These are sample values, there are many <a href='http://www.iso.org/iso/country_codes.htm'>more</a>
  • postalCode string - Postal or zip code
  • state string - State or province or territory

godaddy.orders: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields
  • authorization string - Represents API Key 'Authorization'

godaddy.orders: BillTo

Fields
  • taxId string? - Tax id used for calculating the tax the customer is required to pay

godaddy.orders: 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

godaddy.orders: 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
  • 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-forwarded header
  • 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
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

godaddy.orders: Contact

Fields

godaddy.orders: 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.orders: 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.orders: 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.orders: LineItem

Fields
  • domains string[]? - A collection of domain names purchased if the current product is domain
  • label string - Human readable description of the current product
  • periodUnit string(default "MONTH") - The unit of time that periodCount is measured in
  • pfid int? - Unique identifier of the current product
  • quantity int - Number of the current product included in the specified order

godaddy.orders: LineItemPricing

Fields
  • discount int - Discount off of sale price for given quantity and period <pre>discount = sale - subtotal</pre>
  • list int - List price for given quantity and period
  • sale int - Actual price for the current product
  • savings int - Savings off of list price for given quantity and period <pre>savings = list - subtotal</pre>
  • subtotal int - Price with any discounts and without taxes or fees for given quantity and period
  • taxes int - Taxes for given quantity and period
  • unit record {} - Pricing for a single unit of the given item

godaddy.orders: LineItemPricingTaxDetail

Fields
  • amount int? - Tax amount

godaddy.orders: LineItemSummary

Fields
  • label string - Product label of the current line item

godaddy.orders: LineItemTaxCollector

Fields
  • taxCollectorId int - Unique identifier for the company

godaddy.orders: LineItemUnitPricing

Fields
  • discount int - Discount without consideration of quantity and period
  • list int - List price without consideration of quantity and period
  • sale int - Sale price without consideration of quantity and period
  • savings int - Savings without consideration of quantity and period
  • taxes int - Taxes without consideration of quantity and period

godaddy.orders: Order

Fields
  • createdAt string - Date and time when the current order is created on
  • currency string - Currency in which the order has been placed
  • orderId string - Unique identifier of current order
  • parentOrderId string? - Unique identifier of the parent order. All refund/chargeback orders are tied to the original order. The orginal order's orderId is the parentOrderId of refund/chargeback orders

godaddy.orders: OrderFee

Fields
  • icann int? - Domain registration transaction fee charged by ICANN
  • total int - Sum of all fees

godaddy.orders: OrderList

Fields

godaddy.orders: OrderPricing

Fields
  • discount int - Discount from promotional pricing
  • list int - Sum of list prices for the entire cart
  • savings int - Savings off of list price <pre>savings = list - subtotal</pre>
  • subtotal int - Price with discount and without taxes or fees
  • taxes int - Taxes for the entire cart
  • total int - Price the customer pays <pre>total = subtotal + taxes + fees.total</pre>

godaddy.orders: OrderSummary

Fields
  • createdAt string - Date and time when the current order was created
  • currency string - Currency in which the order was placed
  • orderId int - Unique identifier of the current order
  • parentOrderId string? - Unique identifier of the parent order. All refund/chargeback orders are tied to the original order. The orginal order's orderId is the parentOrderId of refund/chargeback orders

godaddy.orders: OrderSummaryPricing

Fields
  • total string - Total amount charged for the current order. Negative for Refund and Chargeback

godaddy.orders: Pagination

Fields
  • first string? - URI to access the first page
  • last string? - URI to access the last page
  • next string? - URI to access the next page
  • previous string? - URI to access the previous page
  • total int? - Number of records available

godaddy.orders: Payment

Fields
  • amount int - Amount paid by the current payment
  • category string - The category of payment method used at the time of purchase. Most common values are listed in the enum.
  • paymentProfileId string - Unique identifier of the payment profile used by current payment
  • subcategory string? - The subcategory of payment method used at the time of purchase. This field is only set for certain payment categories, such as ACH and CREDIT_CARD. Most common values are listed in the enum.

godaddy.orders: 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

Import

import ballerinax/godaddy.orders;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 2

Current verison: 2

Weekly downloads

Source repository

Keywords

Website & App Building/Website Builders

Cost/Paid

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.0

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC