Ballerina library

godaddy.shopper

Module godaddy.shopper

OverviewPrerequisites

API

Client

Definitions

ApiKeysConfig
ClientHttp1Settings
ConnectionConfig
Error
ErrorField
ErrorLimit
PasswordError
ProxyConfig
Secret
Shopper
ShopperId
ShopperStatus
ShopperUpdate
SubaccountCreate

ballerinax/godaddy.shopper Ballerina library

1.5.1

Overview

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

The GoDaddy Shoppers API provides capability to access GoDaddy operations related to shopper.

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.shopper: Client

Isolated

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

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

createSubaccount

Isolated FunctionRemote Function
function createSubaccount(SubaccountCreate payload) returns ShopperId|error

Create a Subaccount owned by the authenticated Reseller

Parameters
Return Type

get

Isolated FunctionRemote Function
function get(string shopperId, string[]? includes) returns Shopper|error

Get details for the specified Shopper

Parameters
  • shopperId string - Shopper whose details are to be retrieved
  • includes string[]? (default ()) - Additional properties to be included in the response shopper object
Return Type

update

Isolated FunctionRemote Function
function update(string shopperId, ShopperUpdate payload) returns ShopperId|error

Update details for the specified Shopper

Parameters
  • shopperId string - The ID of the Shopper to update
Return Type

delete

Isolated FunctionRemote Function
function delete(string shopperId, string auditClientIp) returns Response|error

Request the deletion of a shopper profile

Parameters
  • shopperId string - The ID of the shopper to delete. Must agree with the shopper id on the token or header, if present. Note: shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)
  • auditClientIp string - The client IP of the user who originated the request leading to this call.
Return Type

getStatus

Isolated FunctionRemote Function
function getStatus(string shopperId, string auditClientIp) returns ShopperStatus|error

Get details for the specified Shopper

Parameters
  • shopperId string - The ID of the shopper to retrieve. Must agree with the shopper id on the token or header, if present
  • auditClientIp string - The client IP of the user who originated the request leading to this call.
Return Type

changePassword

Isolated FunctionRemote Function
function changePassword(string shopperId, Secret payload) returns ShopperId|error

Set subaccount's password

Parameters
  • shopperId string - Shopper whose password will be set
  • payload Secret - The value to set the subaccount's password to
Return Type

Records

godaddy.shopper: ApiKeysConfig

Closed record

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

Fields
  • authorization string - Represents API Key 'Authorization'

godaddy.shopper: 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.shopper: 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.shopper: 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.shopper: 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.shopper: 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.shopper: PasswordError

Fields
  • 'type string? - Response type, always 'error'
  • code string? - Short identifier for the error, suitable for indicating the specific error within client code
  • message string? - Human-readable, English description of the error

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

godaddy.shopper: Secret

Fields
  • secret string? - The secret value used to set a subaccount's password

godaddy.shopper: Shopper

Fields
  • customerId string? - Identifier for the Customer record associated with this Shopper record. This is an alternate identifier that some systems use to identify an individual shopper record
  • externalId int? -

godaddy.shopper: ShopperId

Fields
  • customerId string? - Identifier for the Customer record associated with this Shopper record. This is an alternate identifier that some systems use to identify an individual shopper record

godaddy.shopper: ShopperStatus

Fields
  • billingState string? - Indicates the billing state of the Shopper.<br />ABANDONED: The shopper has not been billed in at least 10 years and has no active subscriptions.<br />INACTIVE: The shopper has been billed within the last 10 years but has no active subscriptions.<br />ACTIVE: The shopper has at least one active subscription.

godaddy.shopper: ShopperUpdate

Fields
  • externalId int? -

godaddy.shopper: SubaccountCreate

Fields
  • externalId int? -
  • marketId string(default "en-US") -

Import

import ballerinax/godaddy.shopper;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: 1

Current verison: 1

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/constraint/1.1.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC