swagger

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 9, 2024 License: Apache-2.0 Imports: 21 Imported by: 10

README

Go API client for swagger

Interact with Hivelocity

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://core.hivelocity.net/api/v2

Class Method HTTP request Description
AccountApi GetAccountCreate Get /account/controlled-client Get all controlled clients for enterprise owner
AccountApi PostAccountCreate Post /account/controlled-client Create controlled client for enterprise owner
AccountApi PutAccountCreate Put /account/controlled-client Deactivate client
BandwidthApi PostDeviceIdBandwidthImageResource Post /bandwidth/device/{deviceId}/image Get PNG by device
BandwidthApi PostDeviceIdBandwidthResource Post /bandwidth/device/{deviceId} Get data by device
BandwidthApi PostServiceIdBandwidthImageResource Post /bandwidth/service/{serviceId}/image Get PNG by service
BandwidthApi PostServiceIdBandwidthResource Post /bandwidth/service/{serviceId} Get data by service
BareMetalDevicesApi DeleteBareMetalDeviceIdResource Delete /bare-metal-devices/{deviceId} Cancel/delete device
BareMetalDevicesApi GetBareMetalDeviceIdResource Get /bare-metal-devices/{deviceId} Get device
BareMetalDevicesApi GetBareMetalDeviceResource Get /bare-metal-devices/ Get all devices
BareMetalDevicesApi PostBareMetalDeviceBatchResource Post /bare-metal-devices/batch Batch provision instant devices
BareMetalDevicesApi PostBareMetalDeviceResource Post /bare-metal-devices/ Provision an instant device
BareMetalDevicesApi PutBareMetalDeviceIdResource Put /bare-metal-devices/{deviceId} Update/reload instant device
BillingInfoApi DeleteBillingInfoIdResource Delete /billing-info/{billingInfoId} Delete a Payment Method by Billing Info ID
BillingInfoApi GetBillingInfoIdResource Get /billing-info/{billingInfoId} Return a Payment Method by Billing Info ID
BillingInfoApi GetBillingInfoResource Get /billing-info/ Return a list with all Payment Methods (Billing Info)
BillingInfoApi GetPaymentMethodsEnableReadResource Get /billing-info/enable Return Payment Methods enabled for editing
BillingInfoApi PostBillingInfoBankAccountCreateResource Post /billing-info/bank-account Add a new Bank Account as a Payment Method
BillingInfoApi PostBillingInfoCreditCardCreateResource Post /billing-info/credit-card Add a new Credit Card as a Payment Method
BillingInfoApi PostBillingInfoResource Post /billing-info/ Create verification for credit card with all Billing Info
BillingInfoApi PutBillingInfoBankAccountUpdateResource Put /billing-info/bank-account/{billingInfoId} Update a Bank Account
BillingInfoApi PutBillingInfoCreditCardUpdateResource Put /billing-info/credit-card/{billingInfoId} Update a Credit Card
BillingInfoApi PutBillingInfoResource Put /billing-info/ Verify credit card with all Billing Info
CancellationsApi DeleteCancellationIdDeleteResource Delete /cancellation/cancellation/{cancellationId} Delete a Cancellation
CancellationsApi GetCancellationDeviceResource Get /cancellation/device/{deviceId} Get cancel request by device
CancellationsApi GetCancellationResource Get /cancellation/cancellation Get all cancel requests
CancellationsApi GetCancellationServiceResource Get /cancellation/service/{serviceId} Get cancel request by service
CancellationsApi PostCancellationResource Post /cancellation/cancellation Create cancel request
ComputeDevicesApi DeleteBareMetalDeviceIdResource Delete /compute/{deviceId} Cancel/delete device
ComputeDevicesApi GetBareMetalDeviceIdResource Get /compute/{deviceId} Get device
ComputeDevicesApi GetBareMetalDeviceResource Get /compute/ Get all devices
ComputeDevicesApi PostBareMetalDeviceBatchResource Post /compute/batch Batch provision instant devices
ComputeDevicesApi PostBareMetalDeviceResource Post /compute/ Provision an instant device
ComputeDevicesApi PutBareMetalDeviceIdResource Put /compute/{deviceId} Update/reload instant device
ContactApi DeleteContactIdResource Delete /contact/{contactId} Delete a Contact
ContactApi GetContactIdResource Get /contact/{contactId} Return details of a specific Contact
ContactApi GetContactResource Get /contact/ Return a list with all Contacts
ContactApi PostContactResource Post /contact/ Create a new Contact
ContactApi PostPasswordReset Post /contact/password Receive a request to reset password, and send a link by email with token
ContactApi PutContactIdResource Put /contact/{contactId} Edit a Contact
ContactApi PutPasswordReset Put /contact/password Receive a token and password, verify the user and reset your password
ContactApi PutPasswordResource Put /contact/{contactId}/password Change password for a Contact
CreditApi GetCreditResource Get /credit/ Return a list with all Credits
CreditApi GetTotalActiveCreditResource Get /credit/total Return the client's total active credit amount
CreditApi PostCreditApplyCouponResource Post /credit/apply-coupon Apply the coupon code for a service
CreditApi PostCreditResource Post /credit/ Receive billing method id and amount and return the created Credit
CreditApi PostCreditValidateCouponResource Post /credit/validate-coupon Validate the coupon code for a service
DeploymentApi DeleteDeploymentIdResource Delete /deploy/{deploymentId} Delete the specified deployment
DeploymentApi GetDeploymentIdResource Get /deploy/{deploymentId} Return a dictionary with deployment information
DeploymentApi GetDeploymentResource Get /deploy/ Return a list with all client deployments
DeploymentApi PostDeploymentIdResource Post /deploy/{deploymentId} Input a billing info id and script to process and finish a deployment
DeploymentApi PostDeploymentResource Post /deploy/ Start a new deployment
DeploymentApi PutDeploymentIdResource Put /deploy/{deploymentId} Receive product, quantity and options to be added on the deployment
DeviceApi DeleteDeviceBondResource Delete /device/{deviceId}/ports/bond Unbond ports
DeviceApi GetAllDeviceTagOrderResource Get /device/tags-order/all Get all tag orders
DeviceApi GetClientDeviceTagOrderResource Get /device/tags-order Get tag order
DeviceApi GetClientDeviceTagResource Get /device/tags Get all tags
DeviceApi GetDeviceIdEventResource Get /device/{deviceId}/events Get all events
DeviceApi GetDeviceIdResource Get /device/{deviceId} Get device
DeviceApi GetDeviceIdServiceResource Get /device/{deviceId}/services Get all device services
DeviceApi GetDeviceIpAssignmentsResource Get /device/{deviceId}/ips Get IPs
DeviceApi GetDeviceIpminatRuleResource Get /device/{deviceId}/ipmi/nat Clear IPMI whitelist
DeviceApi GetDevicePaymentMethodLinkedResource Get /device/linked-payment-method/{billingInfoId} Get by payment method
DeviceApi GetDevicePortResource Get /device/{deviceId}/ports Get ports
DeviceApi GetDeviceResource Get /device/ Get all devices
DeviceApi GetDeviceTagIdResource Get /device/{deviceId}/tags Get device tags
DeviceApi GetEffectiveIgnitionIdResource Get /device/{deviceId}/ignition Get Ignition injections
DeviceApi GetInitialCredsIdResource Get /device/{deviceId}/initial-creds Get initial creds
DeviceApi GetInitialPasswordIdResource Get /device/{deviceId}/initial-password Get initial password
DeviceApi GetIpmiInfoIdResource Get /device/{deviceId}/ipmi Get IPMI data
DeviceApi GetIpmiInfoLoginDataResource Get /device/{deviceId}/ipmi/login-data Get IPMI creds
DeviceApi GetIpmiThresholdsIdResource Get /device/{deviceId}/ipmi/thresholds Get IPMI thresholds
DeviceApi GetIpmiValidLoginIdResource Get /device/{deviceId}/ipmi/valid-login Get IPMI access status
DeviceApi GetPowerResource Get /device/{deviceId}/power Get power status
DeviceApi PostDeviceBondResource Post /device/{deviceId}/ports/bond Bond ports
DeviceApi PostDeviceIpmiWhitelistResource Post /device/{deviceId}/ipmi/whitelist/ Whitelist IP for IPMI
DeviceApi PostDevicePortIdClearResource Post /device/{deviceId}/port/{portId}/clear Clear all Port configurations
DeviceApi PostDeviceReloadResource Post /device/{deviceId}/reload Reload device
DeviceApi PostPowerResource Post /device/{deviceId}/power Update power status
DeviceApi PostPreviewEffectiveIgnitionResource Post /device/preview-ignition Preview Ignition injections
DeviceApi PutClientDeviceTagOrderResource Put /device/tags-order Update tag order
DeviceApi PutDeviceIdResource Put /device/{deviceId} Update device
DeviceApi PutDevicePortResource Put /device/{deviceId}/ports Update port network
DeviceApi PutDeviceTagIdResource Put /device/{deviceId}/tags Update device tags
DeviceApi PutIpmiDevicesThresholdsIdResource Put /device/ipmi/thresholds Bulk update IPMI thresholds
DeviceApi PutIpmiThresholdsIdResource Put /device/{deviceId}/ipmi/thresholds Update IPMI thresholds
DomainsApi DeleteARecordIdResource Delete /domains/{domain}/a-record/{record} Delete a single A Record value for given zone
DomainsApi DeleteAaaaRecordIdResource Delete /domains/{domainID}/aaaa-record/{recordId} Delete an AAAA Record for given zone
DomainsApi DeleteDomainIdResource Delete /domains/{domainId} Delete domain for given id
DomainsApi DeleteMxRecordIdResource Delete /domains/{domainID}/mx-record/{recordId} Delete an MX Record for given zone
DomainsApi GetARecordIdResource Get /domains/{domain}/a-record/{record} Return Single A Records found for given domain name
DomainsApi GetARecordResource Get /domains/{domain}/a-record Return all A Records found for given zone name
DomainsApi GetAaaaRecordIdResource Get /domains/{domainID}/aaaa-record/{recordId} Return Single AAAA Records found for given id
DomainsApi GetAaaaRecordResource Get /domains/{domainID}/aaaa-record Return all AAAA Records found for given zone
DomainsApi GetDomainIdResource Get /domains/{domainId} Return a domain for given id
DomainsApi GetDomainResource Get /domains/ Return the domains of a client
DomainsApi GetMxRecordIdResource Get /domains/{domainID}/mx-record/{recordId} Return Single MX Records found for given id
DomainsApi GetMxRecordResource Get /domains/{domainID}/mx-record Return all MX Records found for given zone
DomainsApi GetPtrRecordIdResource Get /domains/ptr/{recordId} Get PTR record by ID and name
DomainsApi GetPtrRecordResource Get /domains/ptr Return the PTR records of a client
DomainsApi PostARecordResource Post /domains/{domain}/a-record Create a new A Record for given zone
DomainsApi PostAaaaRecordResource Post /domains/{domainID}/aaaa-record Create a new AAAA Record for given zone
DomainsApi PostDomainResource Post /domains/ Create a new domain
DomainsApi PostMxRecordResource Post /domains/{domainID}/mx-record Create a new MX Record for given zone
DomainsApi PutARecordIdResource Put /domains/{domain}/a-record/{record} Update an A Record for given zone
DomainsApi PutAaaaRecordIdResource Put /domains/{domainID}/aaaa-record/{recordId} Update an AAAA Record for given id
DomainsApi PutMxRecordIdResource Put /domains/{domainID}/mx-record/{recordId} Update an MX Record for given zone
DomainsApi PutPtrRecordIdResource Put /domains/ptr/{recordId} Update PTR record
IPAssignmentApi DeleteIpAssignmentIdResource Delete /ip/{ipAssignmentId} Delete assignment
IPAssignmentApi GetIpAssignmentIdResource Get /ip/{ipAssignmentId} Get assignment
IPAssignmentApi GetIpAssignmentResource Get /ip/ Get all assignments
IPAssignmentApi GetIpAssignmentSubnetResource Get /ip/address/{ipAddress} Get assignment by IP
IPAssignmentApi PostIpAssignmentCombineResource Post /ip/combine Combine assignments
IPAssignmentApi PostIpAssignmentIdClearResource Post /ip/{ipAssignmentId}/clear Clear all configuration on an IP Assignment
IPAssignmentApi PostIpAssignmentResource Post /ip/ Request new assignment
IPAssignmentApi PostIpAssignmentSplitResource Post /ip/{ipAssignmentId}/split Split assignment
IPAssignmentApi PutIpAssignmentIdResource Put /ip/{ipAssignmentId} Route assignment to IP
IgnitionApi DeleteIgnitionResourceId Delete /ignition/{ignitionId} Delete an Ignition configuration by ID
IgnitionApi GetIgnitionResource Get /ignition/ Return all Ignition configurations
IgnitionApi GetIgnitionResourceId Get /ignition/{ignitionId} Return an Ignition configuration by ID
IgnitionApi PostIgnitionResource Post /ignition/ Creates a new Ignition configuration
IgnitionApi PutIgnitionResourceId Put /ignition/{ignitionId} Update an Ignition configuration by ID
InventoryApi GetLocationResource Get /inventory/locations Get all facilities
InventoryApi GetStockByProductResource Get /inventory/product/{productId} Get product
InventoryApi GetStockResource Get /inventory/product Get all products
InvoiceApi GetInvoiceIdDetails Get /invoice/{invoiceId}/details Return detailed information for an invoice
InvoiceApi GetInvoiceIdResource Get /invoice/{invoiceId} Return serialized data on a single invoice
InvoiceApi GetInvoicePdfResource Get /invoice/{invoiceId}/pdf-download Return an Invoice PDF file in Base64 Encoded Format
InvoiceApi GetInvoiceResource Get /invoice/ Return serialized data on all invoices
InvoiceApi GetInvoiceSearchResource Get /invoice/search Return results of invoice search
InvoiceApi GetInvoiceUnpaidResource Get /invoice/unpaid Return total balance of all unpaid invoices
InvoiceApi PostInvoiceIdApplyAccountCredit Post /invoice/{invoiceId}/apply-account-credit Apply account credit to an invoice
MaintenanceApi GetMaintenanceEventClientResource Get /maintenance/ Get all Maintenance Events for a client
MaintenanceApi GetMaintenanceEventIdClientResource Get /maintenance/{maintenanceEventId} Get Maintenance Events
NetworkApi DeleteNullRoutesIdResource Delete /network/null-route/{ipAddress} Remove Null Route for an IP Address
NetworkApi GetDeviceNetworkPortResource Get /network/device/ports Get all ports by device
NetworkApi GetNetworkTaskClientResource Get /network/status/ Get network task status
NetworkApi GetNetworkTaskIdResource Get /network/status/{id} Get network task status by Device ID or Task ID
NetworkApi GetNullRoutesIdResource Get /network/null-route/{ipAddress} Return record if IP Address is Null Routed
NetworkApi GetNullRoutesResource Get /network/null-route Return Null Routed IPs
NetworkApi PostNullRoutesResource Post /network/null-route Add a Null Route for an IP Address
OrderApi GetOrderIdResource Get /order/{orderId} Return details of a specific Order
OrderApi GetOrderInprogressResource Get /order/in-progress Return a list of all In-Progress orders
OrderApi GetOrderResource Get /order/ Return a list with all Orders
OrderGroupsApi DeleteOrderGroupIdResource Delete /order-groups/{orderGroupId} Delete the specified Order Group
OrderGroupsApi GetOrderGroupIdResource Get /order-groups/{orderGroupId} Return an Order Group
OrderGroupsApi GetOrderGroupResource Get /order-groups/ Return a list with all Order Groups
OrderGroupsApi PostOrderGroupResource Post /order-groups/ Create a new Order Group
OrderGroupsApi PutOrderGroupIdResource Put /order-groups/{orderGroupId} Update an Order Group
PermissionApi GetPermissionAllResource Get /permission/ Endpoint to get All Permissions
PermissionApi GetPermissionContactResource Get /permission/contact/{contactId} Endpoint to get Contact Permissions
PermissionApi GetPermissionUserResource Get /permission/user Endpoint to get User Permissions
PermissionApi PostPermissionAssignContactResource Post /permission/contact Endpoint to assign a new Permission to a Contact
ProductApi GetProductOperatingSystemsResource Get /product/{productId}/operating-systems Get product operating systems
ProductApi GetProductOptionResource Get /product/{productId}/options Get product options
ProductApi GetProductsAndOptionsResource Get /product/options Get all options
ProfileApi GetBasicProfileResource Get /profile/basic Get Basic Profile of current user or a contact with id
ProfileApi GetProfileResource Get /profile/ Get Profile of current user or a contact with id
ProfileApi PutProfileResource Put /profile/ Update Profile of current user or a contact with id
ServiceApi GetServiceIdResource Get /service/{serviceId} Return a dictionary with data from a specific account service
ServiceApi GetServiceManageableResource Get /service/{serviceId}/manageable Return a dictionary with data verifying managed services eligibility
ServiceApi GetServiceManagedReqResource Get /service/managed-requirements Return a dictionary with managed services operating system and panel requirements
ServiceApi GetServiceResource Get /service/ Return a list of all account services
ServiceApi GetServiceTypeResource Get /service/types Return all available service types
ServiceApi PostServiceIdApplyCouponResource Post /service/{serviceId}/apply-coupon Apply the coupon code for a service
ServiceApi PostServiceIdValidateCouponResource Post /service/{serviceId}/validate-coupon Validate the coupon code for a service
SshKeyApi DeleteSshKeyIdResource Delete /ssh_key/{sshKeyId} Removes public ssh key
SshKeyApi GetSshKeyIdResource Get /ssh_key/{sshKeyId} Get public ssh key
SshKeyApi GetSshKeyResource Get /ssh_key/ Gets all public ssh key
SshKeyApi PostSshKeyResource Post /ssh_key/ Adds public ssh key
SshKeyApi PutSshKeyIdResource Put /ssh_key/{sshKeyId} Updates public ssh key
TicketApi GetTicketIdResource Get /tickets/{ticketId} Returns details of a specific ticket
TicketApi GetTicketReplyResource Get /tickets/{ticketId}/reply Returns a reply for a specific ticket
TicketApi GetTicketResource Get /tickets/ Returns a list with all Tickets
TicketApi GetTicketSearchResource Get /tickets/search Return results of ticket search
TicketApi PostTicketReplyResource Post /tickets/{ticketId}/reply Creates reply for a specific Ticket
TicketApi PostTicketResource Post /tickets/ Creates a new ticket
TicketApi PutTicketIdResource Put /tickets/{ticketId} Updates a specific ticket
TokenApi DeleteTokenResource Delete /token/ Deletes the Public API Token with apiTokenId
TokenApi GetTokenResource Get /token/ Returns a list of Public API Tokens for the current user (last 4 characters only)
TokenApi PostTokenResource Post /token/ Create a new Public API Token for the current user
TokenApi PutTokenResource Put /token/ Updates the Public API Token with apiTokenId
VLANApi DeleteVlanIdResource Delete /vlan/{vlanId} Delete VLAN
VLANApi GetVlanIdResource Get /vlan/{vlanId} Get VLAN
VLANApi GetVlanResource Get /vlan/ Get all VLANs
VLANApi PostVlanIdClearResource Post /vlan/{vlanId}/clear Clear all configurations on this VLAN, including Ports, IPs and associated Static Routes
VLANApi PostVlanResource Post /vlan/ Create VLAN
VLANApi PutVlanIdResource Put /vlan/{vlanId} Modify VLAN
VPSApi DeleteVpsIdNetworkRemoveResource Delete /vps/{deviceId}/network/{networkId} Detach a VPS Network from a VPS Device
VPSApi DeleteVpsNetworkIdResource Delete /vps/network/{networkId} Delete VPS Network
VPSApi DeleteVpsSecondaryIpRemoveResource Delete /vps/{deviceId}/secondaryIp/{ipAssignmentId} Remove a Secondary IP Address from VPS instance
VPSApi DeleteVpsSnapshotIdResource Delete /vps/snapshot/{snapshotId} Delete a VPS Volume Snapshot
VPSApi DeleteVpsSnapshotScheduleIdResource Delete /vps/snapshotSchedule/{snapshotScheduleId} Delete a VPS Snapshot Schedule
VPSApi DeleteVpsVolumeIdResource Delete /vps/volume/{volumeId} Deletes a Volume
VPSApi DeleteVpsisoIdResource Delete /vps/iso/{isoId} Delete an ISO
VPSApi GetVpsAvailableNewVolumesResource Get /vps/available-volume-sizes Gets list of available sizes for new volumes
VPSApi GetVpsAvailableUpgradeSizesResource Get /vps/volume/{volumeId}/available-sizes Get a volume's list of upgradable sizes
VPSApi GetVpsIdEventsResource Get /vps/{deviceId}/events Get VPS Instance Events
VPSApi GetVpsIdResource Get /vps/{deviceId} Get VPS instance
VPSApi GetVpsMetricsResource Get /vps/{deviceId}/metrics Get Metrics for a VPS instance
VPSApi GetVpsNetworkIdResource Get /vps/network/{networkId} Get VPS Network
VPSApi GetVpsNetworkResource Get /vps/network Get all VPS Networks
VPSApi GetVpsResource Get /vps/ Get all VPS instances
VPSApi GetVpsSecondaryIpAddResource Get /vps/{deviceId}/secondaryIp Get all Secondary IP Addresses attached to VPS instance
VPSApi GetVpsSelfMetadataResource Get /vps/self-metadata
VPSApi GetVpsSnapshotIdResource Get /vps/snapshot/{snapshotId} Get a VPS Volume Snapshot by ID
VPSApi GetVpsSnapshotResource Get /vps/snapshot Get all VPS Volume Snapshots available
VPSApi GetVpsSnapshotScheduleIdResource Get /vps/snapshotSchedule/{snapshotScheduleId} Get a VPS Snapshot Schedules
VPSApi GetVpsSnapshotScheduleResource Get /vps/snapshotSchedule Get all VPS Snapshot Schedules for a Facility or VPS Instance
VPSApi GetVpsVolumeIdResource Get /vps/volume/{volumeId} Get a VPS Instance Volume
VPSApi GetVpsVolumeResource Get /vps/volume Get all VPS Instance Volumes available
VPSApi GetVpsisoIdResource Get /vps/iso/{isoId} Get the details of the VPS ISO ID specified
VPSApi GetVpsisoResource Get /vps/iso Get all VPS ISOs available
VPSApi PostVpsAttachIsoResource Post /vps/{deviceId}/attachiso Attach ISO to VPS instance
VPSApi PostVpsAttachVolumeResource Post /vps/{deviceId}/volume/{volumeId}/attach Attach Volume to VPS instance
VPSApi PostVpsConsoleAccessResource Post /vps/{deviceId}/console Create a one time use URL for console access to a VPS instance
VPSApi PostVpsDetachIsoResource Post /vps/{deviceId}/detachiso Detach ISO from VPS instance
VPSApi PostVpsDetachVolumeResource Post /vps/{deviceId}/volume/{volumeId}/detach Detach Volume from VPS instance
VPSApi PostVpsIdNetworkAddResource Post /vps/{deviceId}/network Attach VPS Network to a VPS Device
VPSApi PostVpsNetworkResource Post /vps/network Create a new VPS Network
VPSApi PostVpsResetPasswordResource Post /vps/{deviceId}/reset-password Request token to reset root password for VPS
VPSApi PostVpsSecondaryIpAddResource Post /vps/{deviceId}/secondaryIp Add a Secondary IP Address to VPS instance
VPSApi PostVpsSnapshotIdResource Post /vps/snapshot/{snapshotId} Restore a VPS Volume Snapshot
VPSApi PostVpsSnapshotResource Post /vps/snapshot Create a VPS Volume Snapshot
VPSApi PostVpsSnapshotScheduleResource Post /vps/snapshotSchedule Create a VPS Snapshot Schedule
VPSApi PostVpsVolumeResource Post /vps/volume Creates a new Volume
VPSApi PostVpsisoResource Post /vps/iso Create a new ISO
VPSApi PutVpsIdResource Put /vps/{deviceId} Update VPS instance
VPSApi PutVpsNetworkIdResource Put /vps/network/{networkId} Update VPS Network
VPSApi PutVpsResetPasswordResource Put /vps/{deviceId}/reset-password Reset VPS root password, requires vps to be powered off
VPSApi PutVpsVolumeIdResource Put /vps/volume/{volumeId} Resize a Volume
WebhookApi DeleteWebhookIdResource Delete /webhooks/{webhookId} Deletes a single webhook
WebhookApi GetWebhookEventResource Get /webhooks/events Returns all available Webhook Events
WebhookApi GetWebhookIdResource Get /webhooks/{webhookId} Returns detailed information for a Single Webhook
WebhookApi GetWebhookResource Get /webhooks/ Returns your active Webhooks
WebhookApi PostEventScriptActionTriggerResource Post /webhooks/trigger Queues a webhook for the event script action that was triggered
WebhookApi PostWebhookResource Post /webhooks/ Create a new Webhook for a Webhook Event
WebhookApi PutWebhookIdResource Put /webhooks/{webhookId} Updates a Single Webhook

Documentation For Models

Documentation For Authorization

apiKey

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AccountApi *AccountApiService

	BandwidthApi *BandwidthApiService

	BareMetalDevicesApi *BareMetalDevicesApiService

	BillingInfoApi *BillingInfoApiService

	CancellationsApi *CancellationsApiService

	ComputeDevicesApi *ComputeDevicesApiService

	ContactApi *ContactApiService

	CreditApi *CreditApiService

	DeploymentApi *DeploymentApiService

	DeviceApi *DeviceApiService

	DomainsApi *DomainsApiService

	IPAssignmentApi *IPAssignmentApiService

	IgnitionApi *IgnitionApiService

	InventoryApi *InventoryApiService

	InvoiceApi *InvoiceApiService

	MaintenanceApi *MaintenanceApiService

	NetworkApi *NetworkApiService

	OrderApi *OrderApiService

	OrderGroupsApi *OrderGroupsApiService

	PermissionApi *PermissionApiService

	ProductApi *ProductApiService

	ProfileApi *ProfileApiService

	ServiceApi *ServiceApiService

	SshKeyApi *SshKeyApiService

	TicketApi *TicketApiService

	TokenApi *TokenApiService

	VLANApi *VLANApiService

	VPSApi *VPSApiService

	WebhookApi *WebhookApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Hivelocity API API v2.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type ARecord 

type ARecord struct {
	Name      string   `json:"name"`
	Addresses []string `json:"addresses,omitempty"`
	Ttl       int32    `json:"ttl"`
}

type AaaaRecordCreate 

type AaaaRecordCreate struct {
	Name    string `json:"name"`
	Address string `json:"address"`
	Ttl     int32  `json:"ttl"`
}

type AaaaRecordReturn 

type AaaaRecordReturn struct {
	Address  string `json:"address,omitempty"`
	Id       int32  `json:"id,omitempty"`
	Ttl      int32  `json:"ttl"`
	Type_    string `json:"type"`
	Name     string `json:"name"`
	DomainId int32  `json:"domainId"`
}

type AaaaRecordUpdate 

type AaaaRecordUpdate struct {
	Name    string `json:"name,omitempty"`
	Address string `json:"address,omitempty"`
	Ttl     int32  `json:"ttl,omitempty"`
}

type AccountApiGetAccountCreateOpts 

type AccountApiGetAccountCreateOpts struct {
	XFields optional.String
}

type AccountApiPostAccountCreateOpts 

type AccountApiPostAccountCreateOpts struct {
	XFields optional.String
}

type AccountApiPutAccountCreateOpts 

type AccountApiPutAccountCreateOpts struct {
	XFields optional.String
}

type AccountApiService 

type AccountApiService service

func (*AccountApiService) GetAccountCreate 

func (a *AccountApiService) GetAccountCreate(ctx context.Context, localVarOptionals *AccountApiGetAccountCreateOpts) ([]ControlledClientDump, *http.Response, error)

func (*AccountApiService) PostAccountCreate 

func (a *AccountApiService) PostAccountCreate(ctx context.Context, payload CreateEnterpriseControlledClient, localVarOptionals *AccountApiPostAccountCreateOpts) (ClientCreateDump, *http.Response, error)

func (*AccountApiService) PutAccountCreate 

func (a *AccountApiService) PutAccountCreate(ctx context.Context, payload DeactivateEnterpriseControlledClient, localVarOptionals *AccountApiPutAccountCreateOpts) (ControlledClientDump, *http.Response, error)

type Bandwidth 

type Bandwidth struct {
	// Returns metadata about the query including the 95th percentile values of the returned data, legend for returned data arrays, and query args passed to the query.
	Metadata interface{} `json:"metadata,omitempty"`
	// Returns an array where each item contains a dictionary of data and an identifier for each requested interface. The data itself is an array of arrays where each item is the measurementat the requested `step` and the index of each integer value corresponds with the legend returned in the `metadata`.
	BandwidthData [][]float32 `json:"bandwidthData,omitempty"`
	// The interface(s) displayed in the image.
	Interface_ string `json:"interface,omitempty"`
	// The unique ID of the switch where bandwidth data is measured.
	SwitchId string `json:"switchId,omitempty"`
}

type BandwidthApiPostDeviceIdBandwidthImageResourceOpts 

type BandwidthApiPostDeviceIdBandwidthImageResourceOpts struct {
	Start   optional.Int32
	End     optional.Int32
	XFields optional.String
}

type BandwidthApiPostDeviceIdBandwidthResourceOpts 

type BandwidthApiPostDeviceIdBandwidthResourceOpts struct {
	Historical optional.Bool
	Start      optional.Int32
	End        optional.Int32
	XFields    optional.String
}

type BandwidthApiPostServiceIdBandwidthImageResourceOpts 

type BandwidthApiPostServiceIdBandwidthImageResourceOpts struct {
	Start   optional.Int32
	End     optional.Int32
	XFields optional.String
}

type BandwidthApiPostServiceIdBandwidthResourceOpts 

type BandwidthApiPostServiceIdBandwidthResourceOpts struct {
	Start   optional.Int32
	End     optional.Int32
	XFields optional.String
}

type BandwidthApiService 

type BandwidthApiService service

func (*BandwidthApiService) PostDeviceIdBandwidthImageResource 

func (a *BandwidthApiService) PostDeviceIdBandwidthImageResource(ctx context.Context, deviceId int32, period string, interface_ string, localVarOptionals *BandwidthApiPostDeviceIdBandwidthImageResourceOpts) ([]BandwidthImage, *http.Response, error)

func (*BandwidthApiService) PostDeviceIdBandwidthResource 

func (a *BandwidthApiService) PostDeviceIdBandwidthResource(ctx context.Context, deviceId int32, period string, interface_ string, step int32, localVarOptionals *BandwidthApiPostDeviceIdBandwidthResourceOpts) ([]Bandwidth, *http.Response, error)

func (*BandwidthApiService) PostServiceIdBandwidthImageResource 

func (a *BandwidthApiService) PostServiceIdBandwidthImageResource(ctx context.Context, serviceId int32, period string, interface_ string, localVarOptionals *BandwidthApiPostServiceIdBandwidthImageResourceOpts) ([]BandwidthImage, *http.Response, error)

func (*BandwidthApiService) PostServiceIdBandwidthResource 

func (a *BandwidthApiService) PostServiceIdBandwidthResource(ctx context.Context, serviceId int32, period string, interface_ string, step int32, localVarOptionals *BandwidthApiPostServiceIdBandwidthResourceOpts) ([]Bandwidth, *http.Response, error)

type BandwidthImage 

type BandwidthImage struct {
	// A PNG image of bandwidth usage.
	GraphImage string `json:"graphImage,omitempty"`
	// The interface(s) displayed in the image.
	Interface_ string `json:"interface,omitempty"`
	// The unique ID of the switch where bandwidth data is measured.
	SwitchId string `json:"switchId,omitempty"`
}

type BareMetalDevice 

type BareMetalDevice struct {
	// A facility code. For example `NYC1`.
	LocationName string `json:"locationName,omitempty"`
	VlanId       int32  `json:"vlanId,omitempty"`
	// The unique ID of the service associated with this device.
	ServiceId int32 `json:"serviceId,omitempty"`
	// The post-install/cloud-init script used during this device's last provisioning.
	Script string `json:"script,omitempty"`
	// The first assigned public IP for accessing this device.
	PrimaryIp string `json:"primaryIp,omitempty"`
	// The unique ID of the device.
	DeviceId int32 `json:"deviceId,omitempty"`
	// The unique ID of the order for this device.
	OrderId int32 `json:"orderId,omitempty"`
	// ON|OFF
	PowerStatus string `json:"powerStatus,omitempty"`
	// The name of the operating system currently installed on this device. Note: If you manually reload your own OS over IPMI this value may not reflect the OS currently on your device.
	OsName string `json:"osName,omitempty"`
	// The user specified hostname for the device. Note: If the hostname is changed in the portal or on the device itself this value may not reflect the actual hostname on the device.
	Hostname string `json:"hostname,omitempty"`
	// Contents of custom iPXE used to provision device
	CustomIPXEScriptContents string `json:"customIPXEScriptContents,omitempty"`
	// The name of the product associated with this device.
	ProductName string `json:"productName,omitempty"`
	// User specified values.
	Tags []string `json:"tags,omitempty"`
	// The unique ID of the product associated with this device.
	ProductId      int32 `json:"productId,omitempty"`
	PublicSshKeyId int32 `json:"publicSshKeyId,omitempty"`
	// This device's service's billing period.
	Period string `json:"period,omitempty"`
	// URL of custom iPXE script used to provision device
	CustomIPXEScriptURL string `json:"customIPXEScriptURL,omitempty"`
}

type BareMetalDeviceBatch 

type BareMetalDeviceBatch struct {
	// Unique ID of the group order.
	OrderGroupId int32 `json:"orderGroupId,omitempty"`
	// List of provisioned devices.
	Devices []BareMetalDevice `json:"devices,omitempty"`
}

type BareMetalDeviceBatchCreate 

type BareMetalDeviceBatchCreate struct {
	// Unique ID to identify the group order.
	OrderGroupId int32 `json:"orderGroupId,omitempty"`
	// List of devices to provision.
	Devices []BareMetalDeviceCreate `json:"devices,omitempty"`
}

type BareMetalDeviceCreate 

type BareMetalDeviceCreate struct {
	// A facility code. For example `NYC1`.
	LocationName string `json:"locationName"`
	VlanId       int32  `json:"vlanId,omitempty"`
	// For users with reserved devices. The unique ID of the target device to provision.
	ForceDeviceId int32 `json:"forceDeviceId,omitempty"`
	// The name of the Operating System to provision on this device. Must match name of an operating system product option.
	OsName string `json:"osName"`
	// A FQDN for the device. For example: `example.hivelocity.net`
	Hostname string `json:"hostname"`
	// Contents of iPXE script if not supplying URL
	CustomIPXEScriptContents string `json:"customIPXEScriptContents,omitempty"`
	// hourly|monthly|quarterly|semi-annually|annually|biennial|triennial
	Period string `json:"period,omitempty"`
	// User specified values.
	Tags []string `json:"tags,omitempty"`
	// The unique ID of an Ignition File for FlatcarOS provisions.
	IgnitionId int32 `json:"ignitionId,omitempty"`
	// The unique ID of the desired product to provision.
	ProductId      int32 `json:"productId"`
	PublicSshKeyId int32 `json:"publicSshKeyId,omitempty"`
	// A Cloud-Init script or a post-install script (Bash for Linux or Powershell for Windows).
	Script string `json:"script,omitempty"`
	// URL to download custom iPXE script if not supplying script in entirety
	CustomIPXEScriptURL string `json:"customIPXEScriptURL,omitempty"`
	// If true, ensures the provisioned device supports port bonding. If false, ensures no bonding support.
	BondingSupport bool `json:"bondingSupport,omitempty"`
}

type BareMetalDeviceUpdate 

type BareMetalDeviceUpdate struct {
	// Whether to force a reload even if fields have not changed
	ForceReload bool `json:"forceReload,omitempty"`
	// The name of the Operating System to provision on this device. Must match name of an operating system product option.
	OsName string `json:"osName"`
	// A FQDN for the device. For example: `example.hivelocity.net`
	Hostname string `json:"hostname"`
	// Contents of iPXE script if not specifying URL. If both script URL and contents are not specified, the last iPXE script contents are used if OS selection requires an iPXE script.
	CustomIPXEScriptContents string   `json:"customIPXEScriptContents,omitempty"`
	Tags                     []string `json:"tags,omitempty"`
	// The unique ID of an Ignition File for FlatcarOS provisions.
	IgnitionId     int32 `json:"ignitionId,omitempty"`
	PublicSshKeyId int32 `json:"publicSshKeyId,omitempty"`
	// A Cloud-Init script or a post-install script (Bash for Linux or Powershell for Windows).
	Script string `json:"script,omitempty"`
	// URL to download custom iPXE script if not specifying contents in entirety. If both script URL and contents are not specified, the last iPXE script contents are used if OS selection requires an  iPXE script.
	CustomIPXEScriptURL string `json:"customIPXEScriptURL,omitempty"`
}

type BareMetalDevicesApiGetBareMetalDeviceIdResourceOpts 

type BareMetalDevicesApiGetBareMetalDeviceIdResourceOpts struct {
	XFields optional.String
}

type BareMetalDevicesApiGetBareMetalDeviceResourceOpts 

type BareMetalDevicesApiGetBareMetalDeviceResourceOpts struct {
	XFields optional.String
}

type BareMetalDevicesApiPostBareMetalDeviceBatchResourceOpts 

type BareMetalDevicesApiPostBareMetalDeviceBatchResourceOpts struct {
	XFields optional.String
}

type BareMetalDevicesApiPostBareMetalDeviceResourceOpts 

type BareMetalDevicesApiPostBareMetalDeviceResourceOpts struct {
	XFields optional.String
}

type BareMetalDevicesApiPutBareMetalDeviceIdResourceOpts 

type BareMetalDevicesApiPutBareMetalDeviceIdResourceOpts struct {
	SkipPowerCheck optional.Bool
	XFields        optional.String
}

type BareMetalDevicesApiService 

type BareMetalDevicesApiService service

func (*BareMetalDevicesApiService) DeleteBareMetalDeviceIdResource 

func (a *BareMetalDevicesApiService) DeleteBareMetalDeviceIdResource(ctx context.Context, deviceId int32) (*http.Response, error)

BareMetalDevicesApiService Cancel/delete device

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId

func (*BareMetalDevicesApiService) GetBareMetalDeviceIdResource 

func (a *BareMetalDevicesApiService) GetBareMetalDeviceIdResource(ctx context.Context, deviceId int32, localVarOptionals *BareMetalDevicesApiGetBareMetalDeviceIdResourceOpts) (BareMetalDevice, *http.Response, error)

func (*BareMetalDevicesApiService) GetBareMetalDeviceResource 

func (a *BareMetalDevicesApiService) GetBareMetalDeviceResource(ctx context.Context, localVarOptionals *BareMetalDevicesApiGetBareMetalDeviceResourceOpts) ([]BareMetalDevice, *http.Response, error)

func (*BareMetalDevicesApiService) PostBareMetalDeviceBatchResource 

func (a *BareMetalDevicesApiService) PostBareMetalDeviceBatchResource(ctx context.Context, payload BareMetalDeviceBatchCreate, localVarOptionals *BareMetalDevicesApiPostBareMetalDeviceBatchResourceOpts) (BareMetalDeviceBatch, *http.Response, error)

func (*BareMetalDevicesApiService) PostBareMetalDeviceResource 

func (a *BareMetalDevicesApiService) PostBareMetalDeviceResource(ctx context.Context, payload BareMetalDeviceCreate, localVarOptionals *BareMetalDevicesApiPostBareMetalDeviceResourceOpts) (BareMetalDevice, *http.Response, error)

func (*BareMetalDevicesApiService) PutBareMetalDeviceIdResource 

func (a *BareMetalDevicesApiService) PutBareMetalDeviceIdResource(ctx context.Context, deviceId int32, payload BareMetalDeviceUpdate, localVarOptionals *BareMetalDevicesApiPutBareMetalDeviceIdResourceOpts) (BareMetalDevice, *http.Response, error)

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BasicProfileDump 

type BasicProfileDump struct {
	Login    string      `json:"login,omitempty"`
	First    string      `json:"first,omitempty"`
	Id       int32       `json:"id,omitempty"`
	State    interface{} `json:"state,omitempty"`
	Zip      interface{} `json:"zip,omitempty"`
	Email    string      `json:"email,omitempty"`
	Company  interface{} `json:"company,omitempty"`
	Last     string      `json:"last,omitempty"`
	City     interface{} `json:"city,omitempty"`
	MetaData interface{} `json:"metaData,omitempty"`
	FullName interface{} `json:"fullName,omitempty"`
	IsClient bool        `json:"isClient,omitempty"`
	Country  interface{} `json:"country,omitempty"`
}

type BillingInfo 

type BillingInfo struct {
	// The first name of the individual associated with the billing ID
	First string `json:"first,omitempty"`
	// The bank account number
	AchAccount string `json:"achAccount,omitempty"`
	// The state associated with the billing ID
	State string `json:"state,omitempty"`
	// The zip/postal code associated with the billing ID
	Zip string `json:"zip,omitempty"`
	// The name of the bank associated with the billing ID
	AchBank string `json:"achBank,omitempty"`
	// The email address associated with the billing ID
	Email string `json:"email,omitempty"`
	// The company name associated with the billing ID
	Company string `json:"company,omitempty"`
	// The bank account type (Checking or Savings)
	AchType string `json:"achType,omitempty"`
	// The street address associated with the billing ID
	Address string `json:"address,omitempty"`
	// The verification status of the Credit Card in question
	IsCCVerified bool `json:"isCCVerified,omitempty"`
	// Yes or No for the Pending Verification status
	PendingVerification bool `json:"pendingVerification,omitempty"`
	// The unique Billing ID used to associate Billing Info
	Id int32 `json:"id,omitempty"`
	// The last name of the individual associated with the billing ID
	Last string `json:"last,omitempty"`
	// True if this is the default payment method for future orders
	Default_ bool `json:"default,omitempty"`
	// The country associated with the billing ID
	Country string `json:"country,omitempty"`
	// The expiration date for the credit card
	CcExpire string `json:"ccExpire,omitempty"`
	// The active status associated with the billing ID (0/1)
	Status int32 `json:"status,omitempty"`
	// The credit card network associated with the billing ID
	CcType string `json:"ccType,omitempty"`
	// The city associated with the billing ID in question
	City string `json:"city,omitempty"`
	// The credit card account number
	CcNum string `json:"ccNum,omitempty"`
	// The identification number for the client associated with the Billing info ID
	ClientId int32 `json:"clientId,omitempty"`
	// The bank routing number
	AchAba string `json:"achAba,omitempty"`
	// The type of payment associated with the billing ID ie: CC, ACH etc
	PaymentType string `json:"paymentType,omitempty"`
	// The phone number associated with the billing ID
	Phone string `json:"phone,omitempty"`
}

type BillingInfoApiDeleteBillingInfoIdResourceOpts added in v0.2.0 

type BillingInfoApiDeleteBillingInfoIdResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiGetBillingInfoIdResourceOpts added in v0.2.0 

type BillingInfoApiGetBillingInfoIdResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiGetBillingInfoResourceOpts 

type BillingInfoApiGetBillingInfoResourceOpts struct {
	ClientId optional.Int32
	XFields  optional.String
}

type BillingInfoApiGetPaymentMethodsEnableReadResourceOpts added in v0.2.0 

type BillingInfoApiGetPaymentMethodsEnableReadResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiPostBillingInfoBankAccountCreateResourceOpts added in v0.2.0 

type BillingInfoApiPostBillingInfoBankAccountCreateResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiPostBillingInfoCreditCardCreateResourceOpts added in v0.2.0 

type BillingInfoApiPostBillingInfoCreditCardCreateResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiPostBillingInfoResourceOpts 

type BillingInfoApiPostBillingInfoResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiPutBillingInfoBankAccountUpdateResourceOpts added in v0.2.0 

type BillingInfoApiPutBillingInfoBankAccountUpdateResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiPutBillingInfoCreditCardUpdateResourceOpts added in v0.2.0 

type BillingInfoApiPutBillingInfoCreditCardUpdateResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiPutBillingInfoResourceOpts 

type BillingInfoApiPutBillingInfoResourceOpts struct {
	XFields optional.String
}

type BillingInfoApiService 

type BillingInfoApiService service

func (*BillingInfoApiService) DeleteBillingInfoIdResource added in v0.2.0 

func (a *BillingInfoApiService) DeleteBillingInfoIdResource(ctx context.Context, billingInfoId int32, localVarOptionals *BillingInfoApiDeleteBillingInfoIdResourceOpts) (*http.Response, error)

func (*BillingInfoApiService) GetBillingInfoIdResource added in v0.2.0 

func (a *BillingInfoApiService) GetBillingInfoIdResource(ctx context.Context, billingInfoId int32, localVarOptionals *BillingInfoApiGetBillingInfoIdResourceOpts) (BillingInfo, *http.Response, error)

func (*BillingInfoApiService) GetBillingInfoResource 

func (a *BillingInfoApiService) GetBillingInfoResource(ctx context.Context, localVarOptionals *BillingInfoApiGetBillingInfoResourceOpts) ([]BillingInfo, *http.Response, error)

func (*BillingInfoApiService) GetPaymentMethodsEnableReadResource added in v0.2.0 

func (a *BillingInfoApiService) GetPaymentMethodsEnableReadResource(ctx context.Context, localVarOptionals *BillingInfoApiGetPaymentMethodsEnableReadResourceOpts) (PaymentMethodsEnabled, *http.Response, error)

func (*BillingInfoApiService) PostBillingInfoBankAccountCreateResource added in v0.2.0 

func (a *BillingInfoApiService) PostBillingInfoBankAccountCreateResource(ctx context.Context, payload BillingInfoCreateBankAccount, localVarOptionals *BillingInfoApiPostBillingInfoBankAccountCreateResourceOpts) (BillingInfo, *http.Response, error)

func (*BillingInfoApiService) PostBillingInfoCreditCardCreateResource added in v0.2.0 

func (a *BillingInfoApiService) PostBillingInfoCreditCardCreateResource(ctx context.Context, payload BillingInfoCreateCreditCard, localVarOptionals *BillingInfoApiPostBillingInfoCreditCardCreateResourceOpts) (BillingInfo, *http.Response, error)

func (*BillingInfoApiService) PostBillingInfoResource 

func (a *BillingInfoApiService) PostBillingInfoResource(ctx context.Context, payload BillingInfoVerification, localVarOptionals *BillingInfoApiPostBillingInfoResourceOpts) (BillingInfo, *http.Response, error)

func (*BillingInfoApiService) PutBillingInfoBankAccountUpdateResource added in v0.2.0 

func (a *BillingInfoApiService) PutBillingInfoBankAccountUpdateResource(ctx context.Context, billingInfoId int32, payload BillingInfoCreateBankAccount, localVarOptionals *BillingInfoApiPutBillingInfoBankAccountUpdateResourceOpts) (BillingInfo, *http.Response, error)

func (*BillingInfoApiService) PutBillingInfoCreditCardUpdateResource added in v0.2.0 

func (a *BillingInfoApiService) PutBillingInfoCreditCardUpdateResource(ctx context.Context, billingInfoId int32, payload BillingInfoCreateCreditCard, localVarOptionals *BillingInfoApiPutBillingInfoCreditCardUpdateResourceOpts) (BillingInfo, *http.Response, error)

func (*BillingInfoApiService) PutBillingInfoResource 

func (a *BillingInfoApiService) PutBillingInfoResource(ctx context.Context, payload BillingInfoVerification, localVarOptionals *BillingInfoApiPutBillingInfoResourceOpts) (Credit, *http.Response, error)

type BillingInfoCreateBankAccount added in v0.2.0 

type BillingInfoCreateBankAccount struct {
	// The first name of the individual associated with the billing ID
	First string `json:"first"`
	// The street address associated with the billing ID
	Address string `json:"address"`
	// Make this the default payment method for future orders
	SetDefault bool `json:"setDefault,omitempty"`
	// Make this the default payment method for all services in the client's account
	DefaultAllServices bool `json:"defaultAllServices,omitempty"`
	// The bank account number
	AchAccount string `json:"achAccount"`
	// The state associated with the billing ID
	State string `json:"state"`
	// The zip/postal code associated with the billing ID
	Zip string `json:"zip"`
	// The name of the bank associated with the billing ID
	AchBank string `json:"achBank"`
	// The last name of the individual associated with the billing ID
	Last string `json:"last"`
	// The company name associated with the billing ID
	Company string `json:"company,omitempty"`
	// The email address associated with the billing ID
	Email string `json:"email"`
	// The city associated with the billing ID in question
	City string `json:"city"`
	// The identification number for the client associated with the Billing Info ID
	ClientId int32 `json:"clientId,omitempty"`
	// The bank routing number
	AchAba string `json:"achAba"`
	// The phone number associated with the billing ID
	Phone string `json:"phone"`
	// The 2 digit country code associated with the billing ID
	Country string `json:"country"`
	// The bank account type (`C` for Checking or `S` for Savings)
	AchType string `json:"achType"`
}

type BillingInfoCreateCreditCard added in v0.2.0 

type BillingInfoCreateCreditCard struct {
	// The first name of the individual associated with the billing ID
	First string `json:"first"`
	// The street address associated with the billing ID
	Address string `json:"address"`
	// Make this the default payment method for future orders
	SetDefault bool `json:"setDefault,omitempty"`
	// Make this the default payment method for all services in the client's account
	DefaultAllServices bool `json:"defaultAllServices,omitempty"`
	// The state associated with the billing ID
	State string `json:"state"`
	// The zip/postal code associated with the billing ID
	Zip string `json:"zip"`
	// The last name of the individual associated with the billing ID
	Last string `json:"last"`
	// The company name associated with the billing ID
	Company string `json:"company,omitempty"`
	// The email address associated with the billing ID
	Email string `json:"email"`
	// The credit card network associated with the billing ID: `visa`, `mastercard`, `discover`, `amex`, etc.
	CcType string `json:"ccType"`
	// The city associated with the billing ID in question
	City string `json:"city"`
	// The expiration month for the credit card
	CcExpireMonth string `json:"ccExpireMonth"`
	// The expiration year for the credit card with 2 digits
	CcExpireYear string `json:"ccExpireYear"`
	// The identification number for the client associated with the Billing Info ID
	ClientId int32 `json:"clientId,omitempty"`
	// The credit card account number
	CcNum string `json:"ccNum"`
	// The credit card verification number
	CcCvv2 string `json:"ccCvv2"`
	// The phone number associated with the billing ID
	Phone string `json:"phone"`
	// The 2 digit country code associated with the billing ID
	Country string `json:"country"`
}

type BillingInfoVerification 

type BillingInfoVerification struct {
	// The unique Billing ID used to associate Billing Info
	Id int32 `json:"id"`
	// The order ID associated with this billing ID
	ProvisionOrderId int32 `json:"provisionOrderId,omitempty"`
	// The verification amount posted to the financial institution associated with the billing ID
	VerificationAmount float32 `json:"verificationAmount,omitempty"`
}

type Cancellation 

type Cancellation struct {
	// Sales Rep ID.
	SalesRepId int32 `json:"salesRepId,omitempty"`
	// Unique ID of a service.
	ServiceId int32 `json:"serviceId,omitempty"`
	// Type of the coupon.
	CouponType string `json:"couponType,omitempty"`
	// Date of cancellation completion.
	DeletedAt time.Time `json:"deletedAt,omitempty"`
	// True if cancel completed.
	Cancelled bool `json:"cancelled,omitempty"`
	// Date of cancellation.
	CancelDate time.Time `json:"cancelDate,omitempty"`
	// Unique ID of a device.
	DeviceId int32 `json:"deviceId,omitempty"`
	// Date of cancel request submission.
	StartDate time.Time `json:"startDate,omitempty"`
	// Code of the coupon.
	CouponCode string `json:"couponCode,omitempty"`
	// Details why the device is being cancelled
	Comments string `json:"comments,omitempty"`
	// Name of the coupon used.
	CouponName string `json:"couponName,omitempty"`
	// The number of months the target device has been active.
	ActiveMonths int32 `json:"activeMonths,omitempty"`
	// Unique ID of the cancellation request.
	Id int32 `json:"id,omitempty"`
	// The monthly cost of the cancelled device.
	MonthlyPayment int32 `json:"monthlyPayment,omitempty"`
	// Name of user who submitted the request
	Name string `json:"name,omitempty"`
	// Deprecated.
	PlanId int32 `json:"planId,omitempty"`
	// The requested cancellation date, if specified.
	RequestDate time.Time `json:"requestDate,omitempty"`
	// Unique ID of a client.
	ClientId int32 `json:"clientId,omitempty"`
	// Value of the coupon.
	CouponValue int32 `json:"couponValue,omitempty"`
	// Reason
	Reason string `json:"reason,omitempty"`
}

type CancellationCreate 

type CancellationCreate struct {
	// Unique ID of a device. Must be related to `service_id`.
	DeviceId int32 `json:"deviceId"`
	// Details why the device is being cancelled
	Comments string `json:"comments,omitempty"`
	// Unique ID of a service. Must be related to `device_id`.
	ServiceId int32 `json:"serviceId"`
	// My current service is being upgraded|Hardware/software/network or power issues|I think I have found a better deal|I have experienced tech support problems|I am consolidating my Hivelocity accounts|I am a reseller and my customer cancelled|I am moving to a different technology solution: Public Cloud|I am moving to a different technology solution: Managed Hosting Company|A product difference (Example: AWS)
	Reason string `json:"reason"`
}

type CancellationsApiGetCancellationDeviceResourceOpts 

type CancellationsApiGetCancellationDeviceResourceOpts struct {
	XFields optional.String
}

type CancellationsApiGetCancellationResourceOpts 

type CancellationsApiGetCancellationResourceOpts struct {
	XFields optional.String
}

type CancellationsApiGetCancellationServiceResourceOpts 

type CancellationsApiGetCancellationServiceResourceOpts struct {
	XFields optional.String
}

type CancellationsApiPostCancellationResourceOpts 

type CancellationsApiPostCancellationResourceOpts struct {
	XFields optional.String
}

type CancellationsApiService 

type CancellationsApiService service

func (*CancellationsApiService) DeleteCancellationIdDeleteResource added in v0.2.0 

func (a *CancellationsApiService) DeleteCancellationIdDeleteResource(ctx context.Context, cancellationId int32) (*http.Response, error)

CancellationsApiService Delete a Cancellation

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param cancellationId

func (*CancellationsApiService) GetCancellationDeviceResource 

func (a *CancellationsApiService) GetCancellationDeviceResource(ctx context.Context, deviceId int32, localVarOptionals *CancellationsApiGetCancellationDeviceResourceOpts) (Cancellation, *http.Response, error)

func (*CancellationsApiService) GetCancellationResource 

func (a *CancellationsApiService) GetCancellationResource(ctx context.Context, localVarOptionals *CancellationsApiGetCancellationResourceOpts) ([]Cancellation, *http.Response, error)

func (*CancellationsApiService) GetCancellationServiceResource 

func (a *CancellationsApiService) GetCancellationServiceResource(ctx context.Context, serviceId int32, localVarOptionals *CancellationsApiGetCancellationServiceResourceOpts) (Cancellation, *http.Response, error)

func (*CancellationsApiService) PostCancellationResource 

func (a *CancellationsApiService) PostCancellationResource(ctx context.Context, payload CancellationCreate, localVarOptionals *CancellationsApiPostCancellationResourceOpts) (Cancellation, *http.Response, error)

type CartCoupon 

type CartCoupon struct {
	// Coupon code
	Code string `json:"code"`
}

type CartCouponDump 

type CartCouponDump struct {
	// Can apply credit to cart
	CanApplyCreditToCart bool `json:"canApplyCreditToCart,omitempty"`
	// Coupon usage type limit max_total|one_per_user|one_per_user_in_24_hours
	UsageTypeLimit []string `json:"usageTypeLimit,omitempty"`
	// Set end date
	HasEndDate bool `json:"hasEndDate"`
	// Clients ids the coupon will be available
	ClientIds []int32   `json:"clientIds,omitempty"`
	Created   time.Time `json:"created,omitempty"`
	// Coupon expire value
	ExpireValue     int32                          `json:"expireValue,omitempty"`
	UsageStatistics *CartCouponUsageStatisticsDump `json:"usageStatistics,omitempty"`
	// Account applicable credit
	AccountApplicableCredit bool `json:"accountApplicableCredit,omitempty"`
	// Minimum purchase requirement
	MinimumPurchaseAmount float32 `json:"minimumPurchaseAmount,omitempty"`
	// Coupon value
	Value float32 `json:"value"`
	// Maximum purchase requirement max
	MaximumPurchaseAmount float32 `json:"maximumPurchaseAmount,omitempty"`
	// Coupon type %|$|credit
	Type_ string `json:"type"`
	// Coupon service eligibility none|all
	ServiceEligibility string `json:"serviceEligibility,omitempty"`
	// Eligible client rules to use this coupon block_enterprise_client|block_reseller|block_partner|has_no_purchase|has_one_purchase|has_multiple_purchase|account_created_recently
	CustomerEligibilityRules []string `json:"customerEligibilityRules,omitempty"`
	// Coupon active
	Active bool `json:"active,omitempty"`
	// Max use same cart
	MaxUseSameCart int32 `json:"maxUseSameCart,omitempty"`
	// Coupon customer eligibility all|rules|specific
	CustomerEligibility string `json:"customerEligibility"`
	Id                  int32  `json:"id,omitempty"`
	// Coupon name
	Name string `json:"name"`
	// Allow other discounts
	AllowOtherDiscounts bool        `json:"allowOtherDiscounts"`
	UserLoginRequired   interface{} `json:"userLoginRequired,omitempty"`
	// Coupon max uses
	MaxUsageLimit int32 `json:"maxUsageLimit,omitempty"`
	// Coupon max use same cart use type first_item|highest_price
	MaxUseSameCartUseType string `json:"maxUseSameCartUseType,omitempty"`
	// Coupon code
	Code string `json:"code"`
	// Coupon end date
	End string `json:"end,omitempty"`
	// Products ids the coupon will be available
	ProductIds []int32 `json:"productIds,omitempty"`
	// Coupon expire type first_billing_period|number_of_days|never_expire
	ExpireType string `json:"expireType"`
	// Coupon start date
	Start string `json:"start"`
}

type CartCouponUsageStatisticsDump added in v0.2.0 

type CartCouponUsageStatisticsDump struct {
	// Total of the coupon applied to existing services
	TotalServices int32 `json:"totalServices,omitempty"`
	// Total of the coupon applied to accounts
	TotalAccountCredits int32 `json:"totalAccountCredits,omitempty"`
	// Total of completed carts with coupon
	TotalCompletedCarts int32 `json:"totalCompletedCarts,omitempty"`
	// Total of carts with coupon
	TotalCarts int32 `json:"totalCarts,omitempty"`
	// Coupon total remaining
	TotalRemaining int32 `json:"totalRemaining,omitempty"`
	// Coupon total abandoned carts
	TotalAbandonedCarts int32 `json:"totalAbandonedCarts,omitempty"`
	// Coupon total uses
	TotalUses int32 `json:"totalUses,omitempty"`
}

type CityStateCountry 

type CityStateCountry struct {
	City    string `json:"city,omitempty"`
	State   string `json:"state,omitempty"`
	Country string `json:"country,omitempty"`
}

type Client 

type Client struct {
	Login    string      `json:"login,omitempty"`
	First    string      `json:"first,omitempty"`
	MetaData interface{} `json:"metaData,omitempty"`
	Id       float32     `json:"id,omitempty"`
	State    string      `json:"state,omitempty"`
	Zip      string      `json:"zip,omitempty"`
	Email    string      `json:"email,omitempty"`
	Last     string      `json:"last,omitempty"`
	FullName string      `json:"fullName,omitempty"`
	Company  string      `json:"company,omitempty"`
	City     string      `json:"city,omitempty"`
	IsClient bool        `json:"isClient,omitempty"`
	Country  string      `json:"country,omitempty"`
}

type ClientCreateDump 

type ClientCreateDump struct {
	// The street address associated with the account
	Address string `json:"address,omitempty"`
	// The first name associated with the account
	First string `json:"first,omitempty"`
	// The ID of the client/contact account
	Id int32 `json:"id,omitempty"`
	// The fax number associated with the account
	Fax string `json:"fax,omitempty"`
	// The state associated with the account
	State string `json:"state,omitempty"`
	// The zip/postal code associated with the account
	Zip string `json:"zip,omitempty"`
	// The email address associated with the account
	Email string `json:"email,omitempty"`
	// The company name associated with the account
	Company string `json:"company,omitempty"`
	// The last name associated with the account
	Last string `json:"last,omitempty"`
	// The date/time the account was created
	Created int32 `json:"created,omitempty"`
	// The country associated with the account
	Country  string `json:"country,omitempty"`
	Password string `json:"password,omitempty"`
	// The city associated with the account
	City   string `json:"city,omitempty"`
	Active bool   `json:"active,omitempty"`
	// The phone number associated with the account
	Phone string `json:"phone,omitempty"`
}

type ComputeDevicesApiGetBareMetalDeviceIdResourceOpts added in v0.2.0 

type ComputeDevicesApiGetBareMetalDeviceIdResourceOpts struct {
	XFields optional.String
}

type ComputeDevicesApiGetBareMetalDeviceResourceOpts added in v0.2.0 

type ComputeDevicesApiGetBareMetalDeviceResourceOpts struct {
	XFields optional.String
}

type ComputeDevicesApiPostBareMetalDeviceBatchResourceOpts added in v0.2.0 

type ComputeDevicesApiPostBareMetalDeviceBatchResourceOpts struct {
	XFields optional.String
}

type ComputeDevicesApiPostBareMetalDeviceResourceOpts added in v0.2.0 

type ComputeDevicesApiPostBareMetalDeviceResourceOpts struct {
	XFields optional.String
}

type ComputeDevicesApiPutBareMetalDeviceIdResourceOpts added in v0.2.0 

type ComputeDevicesApiPutBareMetalDeviceIdResourceOpts struct {
	SkipPowerCheck optional.Bool
	XFields        optional.String
}

type ComputeDevicesApiService added in v0.2.0 

type ComputeDevicesApiService service

func (*ComputeDevicesApiService) DeleteBareMetalDeviceIdResource added in v0.2.0 

func (a *ComputeDevicesApiService) DeleteBareMetalDeviceIdResource(ctx context.Context, deviceId int32) (*http.Response, error)

ComputeDevicesApiService Cancel/delete device

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId

func (*ComputeDevicesApiService) GetBareMetalDeviceIdResource added in v0.2.0 

func (a *ComputeDevicesApiService) GetBareMetalDeviceIdResource(ctx context.Context, deviceId int32, localVarOptionals *ComputeDevicesApiGetBareMetalDeviceIdResourceOpts) (BareMetalDevice, *http.Response, error)

func (*ComputeDevicesApiService) GetBareMetalDeviceResource added in v0.2.0 

func (a *ComputeDevicesApiService) GetBareMetalDeviceResource(ctx context.Context, localVarOptionals *ComputeDevicesApiGetBareMetalDeviceResourceOpts) ([]BareMetalDevice, *http.Response, error)

func (*ComputeDevicesApiService) PostBareMetalDeviceBatchResource added in v0.2.0 

func (a *ComputeDevicesApiService) PostBareMetalDeviceBatchResource(ctx context.Context, payload BareMetalDeviceBatchCreate, localVarOptionals *ComputeDevicesApiPostBareMetalDeviceBatchResourceOpts) (BareMetalDeviceBatch, *http.Response, error)

func (*ComputeDevicesApiService) PostBareMetalDeviceResource added in v0.2.0 

func (a *ComputeDevicesApiService) PostBareMetalDeviceResource(ctx context.Context, payload BareMetalDeviceCreate, localVarOptionals *ComputeDevicesApiPostBareMetalDeviceResourceOpts) (BareMetalDevice, *http.Response, error)

func (*ComputeDevicesApiService) PutBareMetalDeviceIdResource added in v0.2.0 

func (a *ComputeDevicesApiService) PutBareMetalDeviceIdResource(ctx context.Context, deviceId int32, payload BareMetalDeviceUpdate, localVarOptionals *ComputeDevicesApiPutBareMetalDeviceIdResourceOpts) (BareMetalDevice, *http.Response, error)

type Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

type ContactApiGetContactIdResourceOpts 

type ContactApiGetContactIdResourceOpts struct {
	XFields optional.String
}

type ContactApiGetContactResourceOpts 

type ContactApiGetContactResourceOpts struct {
	XFields optional.String
}

type ContactApiPostContactResourceOpts 

type ContactApiPostContactResourceOpts struct {
	XFields optional.String
}

type ContactApiPutContactIdResourceOpts 

type ContactApiPutContactIdResourceOpts struct {
	XFields optional.String
}

type ContactApiService 

type ContactApiService service

func (*ContactApiService) DeleteContactIdResource 

func (a *ContactApiService) DeleteContactIdResource(ctx context.Context, contactId int32) (*http.Response, error)

ContactApiService Delete a Contact

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contactId ID of Contact to View / Update

func (*ContactApiService) GetContactIdResource 

func (a *ContactApiService) GetContactIdResource(ctx context.Context, contactId int32, localVarOptionals *ContactApiGetContactIdResourceOpts) (ContactDump, *http.Response, error)

func (*ContactApiService) GetContactResource 

func (a *ContactApiService) GetContactResource(ctx context.Context, localVarOptionals *ContactApiGetContactResourceOpts) ([]ContactDump, *http.Response, error)

func (*ContactApiService) PostContactResource 

func (a *ContactApiService) PostContactResource(ctx context.Context, payload ContactCreate, localVarOptionals *ContactApiPostContactResourceOpts) (ContactDump, *http.Response, error)

func (*ContactApiService) PostPasswordReset 

func (a *ContactApiService) PostPasswordReset(ctx context.Context, payload PasswordRequest) (*http.Response, error)

ContactApiService Receive a request to reset password, and send a link by email with token

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param payload

func (*ContactApiService) PutContactIdResource 

func (a *ContactApiService) PutContactIdResource(ctx context.Context, contactId int32, payload ContactUpdate, localVarOptionals *ContactApiPutContactIdResourceOpts) (ContactDump, *http.Response, error)

func (*ContactApiService) PutPasswordReset 

func (a *ContactApiService) PutPasswordReset(ctx context.Context, payload PasswordResponse) (*http.Response, error)

ContactApiService Receive a token and password, verify the user and reset your password

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param payload

func (*ContactApiService) PutPasswordResource 

func (a *ContactApiService) PutPasswordResource(ctx context.Context, contactId int32, payload Password) (*http.Response, error)

ContactApiService Change password for a Contact

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contactId \"ID of Contact to change password\"
  • @param payload

type ContactCreate 

type ContactCreate struct {
	Email       string `json:"email"`
	Password    string `json:"password,omitempty"`
	FullName    string `json:"fullName"`
	Active      int32  `json:"active"`
	Phone       string `json:"phone,omitempty"`
	Description string `json:"description,omitempty"`
}

type ContactDump 

type ContactDump struct {
	Email        string `json:"email"`
	FullName     string `json:"fullName"`
	IsClient     bool   `json:"isClient,omitempty"`
	ClientId     int32  `json:"clientId,omitempty"`
	ReferralCode string `json:"referralCode,omitempty"`
	Active       int32  `json:"active"`
	Phone        string `json:"phone,omitempty"`
	Description  string `json:"description,omitempty"`
	ContactId    int32  `json:"contactId,omitempty"`
}

type ContactUpdate 

type ContactUpdate struct {
	Email       string `json:"email,omitempty"`
	FullName    string `json:"fullName,omitempty"`
	Active      int32  `json:"active,omitempty"`
	Phone       string `json:"phone,omitempty"`
	Description string `json:"description,omitempty"`
}

type ControlledClientDump 

type ControlledClientDump struct {
	// The street address associated with the account
	Address string `json:"address,omitempty"`
	// The first name associated with the account
	First string `json:"first,omitempty"`
	// The ID of the client/contact account
	Id int32 `json:"id,omitempty"`
	// The fax number associated with the account
	Fax string `json:"fax,omitempty"`
	// The state associated with the account
	State string `json:"state,omitempty"`
	// The zip/postal code associated with the account
	Zip string `json:"zip,omitempty"`
	// The email address associated with the account
	Email string `json:"email,omitempty"`
	// The company name associated with the account
	Company string `json:"company,omitempty"`
	// The last name associated with the account
	Last string `json:"last,omitempty"`
	// The date/time the account was created
	Created int32 `json:"created,omitempty"`
	// The country associated with the account
	Country string `json:"country,omitempty"`
	// The city associated with the account
	City   string `json:"city,omitempty"`
	Active bool   `json:"active,omitempty"`
	// The phone number associated with the account
	Phone string `json:"phone,omitempty"`
}

type CreateCredit 

type CreateCredit struct {
	// The Billing Info ID used to purchase the credits on this account
	BillingInfoId int32 `json:"billingInfoId,omitempty"`
	// The amount of credit associated with the credit ID
	Amount float32 `json:"amount,omitempty"`
}

type CreateEnterpriseControlledClient 

type CreateEnterpriseControlledClient struct {
	// The client account password to be used
	Password string `json:"password,omitempty"`
	// The company to be asociated with the client account
	Company string `json:"company"`
	// The email to be associated with the client account
	Email string `json:"email"`
}

type CreateIgnition 

type CreateIgnition struct {
	Name     string `json:"name,omitempty"`
	Contents string `json:"contents,omitempty"`
}

type Credit 

type Credit struct {
	// The ID corresponding to a particular credit
	Id int32 `json:"id,omitempty"`
	// The amount of credit associated with the credit ID
	Amount float32 `json:"amount,omitempty"`
	// The amount of credit available for use associated with the credit ID
	Balance float32 `json:"balance,omitempty"`
	// The client ID associated with the credit ID
	ClientId int32 `json:"clientId,omitempty"`
	// The created date/time of the credit
	Created int32 `json:"created,omitempty"`
	// The order ID associated with the credit ID
	OrderId int32 `json:"orderId,omitempty"`
	// The reason code for the creation of the credit
	Reason string `json:"reason,omitempty"`
	// The status of the credit
	Status string `json:"status,omitempty"`
	// If credit is for hourly billing
	IsHourly bool `json:"isHourly,omitempty"`
	// The Billing Info ID used to purchase the credits on this account
	BillingInfoId int32 `json:"billingInfoId,omitempty"`
	// The list of service IDs associated with the credit ID
	ServiceIds []int32 `json:"serviceIds,omitempty"`
	// Whether credits are automatically being applied to new orders or invoices. [0 = Not Auto Apply, 1 = Auto Apply New Invoices, 2 = Auto Apply All Invoices]
	AutoApply int32 `json:"autoApply,omitempty"`
	// The expiration date of the credit
	ExpirationDate int32 `json:"expirationDate,omitempty"`
}

type CreditApiGetCreditResourceOpts 

type CreditApiGetCreditResourceOpts struct {
	Status  optional.String
	XFields optional.String
}

type CreditApiGetTotalActiveCreditResourceOpts 

type CreditApiGetTotalActiveCreditResourceOpts struct {
	XFields optional.String
}

type CreditApiPostCreditApplyCouponResourceOpts 

type CreditApiPostCreditApplyCouponResourceOpts struct {
	XFields optional.String
}

type CreditApiPostCreditResourceOpts 

type CreditApiPostCreditResourceOpts struct {
	XFields optional.String
}

type CreditApiPostCreditValidateCouponResourceOpts 

type CreditApiPostCreditValidateCouponResourceOpts struct {
	XFields optional.String
}

type CreditApiService 

type CreditApiService service

func (*CreditApiService) GetCreditResource 

func (a *CreditApiService) GetCreditResource(ctx context.Context, localVarOptionals *CreditApiGetCreditResourceOpts) ([]Credit, *http.Response, error)

func (*CreditApiService) GetTotalActiveCreditResource 

func (a *CreditApiService) GetTotalActiveCreditResource(ctx context.Context, localVarOptionals *CreditApiGetTotalActiveCreditResourceOpts) (TotalActiveCredit, *http.Response, error)

func (*CreditApiService) PostCreditApplyCouponResource 

func (a *CreditApiService) PostCreditApplyCouponResource(ctx context.Context, payload CartCoupon, localVarOptionals *CreditApiPostCreditApplyCouponResourceOpts) (Credit, *http.Response, error)

func (*CreditApiService) PostCreditResource 

func (a *CreditApiService) PostCreditResource(ctx context.Context, payload CreateCredit, localVarOptionals *CreditApiPostCreditResourceOpts) (Credit, *http.Response, error)

func (*CreditApiService) PostCreditValidateCouponResource 

func (a *CreditApiService) PostCreditValidateCouponResource(ctx context.Context, payload CartCoupon, localVarOptionals *CreditApiPostCreditValidateCouponResourceOpts) (ValidateCartCouponDump, *http.Response, error)

type DeactivateEnterpriseControlledClient 

type DeactivateEnterpriseControlledClient struct {
	// ID of the controlled client account
	ClientId int32 `json:"clientId"`
}

type DeleteApiTokenLoad 

type DeleteApiTokenLoad struct {
	ApiTokenId string `json:"apiTokenId,omitempty"`
}

type Deployment 

type Deployment struct {
	DeploymentId            int32         `json:"deploymentId,omitempty"`
	StartedProvisioning     bool          `json:"startedProvisioning,omitempty"`
	DeploymentName          string        `json:"deploymentName,omitempty"`
	Empty                   bool          `json:"empty,omitempty"`
	Price                   float32       `json:"price,omitempty"`
	OrderNumber             string        `json:"orderNumber,omitempty"`
	DeploymentConfiguration []interface{} `json:"deploymentConfiguration,omitempty"`
}

type DeploymentApiGetDeploymentIdResourceOpts 

type DeploymentApiGetDeploymentIdResourceOpts struct {
	XFields optional.String
}

type DeploymentApiGetDeploymentResourceOpts 

type DeploymentApiGetDeploymentResourceOpts struct {
	XFields optional.String
}

type DeploymentApiPostDeploymentResourceOpts 

type DeploymentApiPostDeploymentResourceOpts struct {
	DeploymentName optional.String
	XFields        optional.String
}

type DeploymentApiPutDeploymentIdResourceOpts 

type DeploymentApiPutDeploymentIdResourceOpts struct {
	XFields optional.String
}

type DeploymentApiService 

type DeploymentApiService service

func (*DeploymentApiService) DeleteDeploymentIdResource 

func (a *DeploymentApiService) DeleteDeploymentIdResource(ctx context.Context, deploymentId int32) (*http.Response, error)

DeploymentApiService Delete the specified deployment

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deploymentId Id of the deployment to interact with

func (*DeploymentApiService) GetDeploymentIdResource 

func (a *DeploymentApiService) GetDeploymentIdResource(ctx context.Context, deploymentId int32, localVarOptionals *DeploymentApiGetDeploymentIdResourceOpts) (Deployment, *http.Response, error)

func (*DeploymentApiService) GetDeploymentResource 

func (a *DeploymentApiService) GetDeploymentResource(ctx context.Context, localVarOptionals *DeploymentApiGetDeploymentResourceOpts) ([]Deployment, *http.Response, error)

func (*DeploymentApiService) PostDeploymentIdResource 

func (a *DeploymentApiService) PostDeploymentIdResource(ctx context.Context, deploymentId int32, payload DeploymentStart) (*http.Response, error)

DeploymentApiService Input a billing info id and script to process and finish a deployment

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deploymentId Id of the deployment to interact with
  • @param payload

func (*DeploymentApiService) PostDeploymentResource 

func (a *DeploymentApiService) PostDeploymentResource(ctx context.Context, localVarOptionals *DeploymentApiPostDeploymentResourceOpts) (Deployment, *http.Response, error)

func (*DeploymentApiService) PutDeploymentIdResource 

func (a *DeploymentApiService) PutDeploymentIdResource(ctx context.Context, deploymentId int32, payload DeploymentCustomization, localVarOptionals *DeploymentApiPutDeploymentIdResourceOpts) (Deployment, *http.Response, error)

type DeploymentCustomization 

type DeploymentCustomization struct {
	// must be one of ['monthly', 'quarterly', 'semi-annually', 'annually', 'biennial', 'triennial', 'hourly']
	BillingPeriod string `json:"billingPeriod,omitempty"`
	// Operating System's Name or ID
	OperatingSystem string  `json:"operatingSystem"`
	Options         []int32 `json:"options,omitempty"`
	// Contents of iPXE script if not supplying URL
	CustomIPXEScriptContents string `json:"customIPXEScriptContents,omitempty"`
	// ID of SSH Key to use for deployment
	PublicSshKeyId int32  `json:"publicSshKeyId,omitempty"`
	LocationCode   string `json:"locationCode,omitempty"`
	// Specify Ignition file ID for CoreOS/Flatcar provisions
	IgnitionIds []int32 `json:"ignitionIds,omitempty"`
	// URL to download custom iPXE script if not supplying script in entirety
	CustomIPXEScriptURL string `json:"customIPXEScriptURL,omitempty"`
	ProductId           int32  `json:"productId"`
	// Either deploy these Device IDs or fail
	ForceDeviceIds  []int32  `json:"forceDeviceIds,omitempty"`
	AdditionalNotes []string `json:"additionalNotes,omitempty"`
	Hostnames       []string `json:"hostnames"`
	Quantity        int32    `json:"quantity,omitempty"`
}

type DeploymentStart 

type DeploymentStart struct {
	Script      string `json:"script,omitempty"`
	BillingInfo int32  `json:"billingInfo"`
}

type DeviceApiDeleteDeviceBondResourceOpts 

type DeviceApiDeleteDeviceBondResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetAllDeviceTagOrderResourceOpts 

type DeviceApiGetAllDeviceTagOrderResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetClientDeviceTagOrderResourceOpts 

type DeviceApiGetClientDeviceTagOrderResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetClientDeviceTagResourceOpts 

type DeviceApiGetClientDeviceTagResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetDeviceIdEventResourceOpts 

type DeviceApiGetDeviceIdEventResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetDeviceIdResourceOpts 

type DeviceApiGetDeviceIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetDeviceIdServiceResourceOpts 

type DeviceApiGetDeviceIdServiceResourceOpts struct {
	GroupBy  optional.String
	TypeCode optional.String
}

type DeviceApiGetDeviceIpAssignmentsResourceOpts 

type DeviceApiGetDeviceIpAssignmentsResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetDevicePaymentMethodLinkedResourceOpts added in v0.2.0 

type DeviceApiGetDevicePaymentMethodLinkedResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetDevicePortResourceOpts 

type DeviceApiGetDevicePortResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetDeviceResourceOpts 

type DeviceApiGetDeviceResourceOpts struct {
	RackId  optional.Int32
	XFields optional.String
}

type DeviceApiGetDeviceTagIdResourceOpts 

type DeviceApiGetDeviceTagIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetEffectiveIgnitionIdResourceOpts 

type DeviceApiGetEffectiveIgnitionIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetInitialCredsIdResourceOpts 

type DeviceApiGetInitialCredsIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetInitialPasswordIdResourceOpts 

type DeviceApiGetInitialPasswordIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetIpmiInfoIdResourceOpts 

type DeviceApiGetIpmiInfoIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetIpmiInfoLoginDataResourceOpts 

type DeviceApiGetIpmiInfoLoginDataResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetIpmiThresholdsIdResourceOpts 

type DeviceApiGetIpmiThresholdsIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetIpmiValidLoginIdResourceOpts 

type DeviceApiGetIpmiValidLoginIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiGetPowerResourceOpts 

type DeviceApiGetPowerResourceOpts struct {
	XFields optional.String
}

type DeviceApiPostDeviceBondResourceOpts 

type DeviceApiPostDeviceBondResourceOpts struct {
	XFields optional.String
}

type DeviceApiPostDevicePortIdClearResourceOpts 

type DeviceApiPostDevicePortIdClearResourceOpts struct {
	XFields optional.String
}

type DeviceApiPostDeviceReloadResourceOpts 

type DeviceApiPostDeviceReloadResourceOpts struct {
	XFields optional.String
}

type DeviceApiPostPowerResourceOpts 

type DeviceApiPostPowerResourceOpts struct {
	XFields optional.String
}

type DeviceApiPostPreviewEffectiveIgnitionResourceOpts 

type DeviceApiPostPreviewEffectiveIgnitionResourceOpts struct {
	XFields optional.String
}

type DeviceApiPutClientDeviceTagOrderResourceOpts 

type DeviceApiPutClientDeviceTagOrderResourceOpts struct {
	XFields optional.String
}

type DeviceApiPutDeviceIdResourceOpts 

type DeviceApiPutDeviceIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiPutDevicePortResourceOpts 

type DeviceApiPutDevicePortResourceOpts struct {
	XFields optional.String
}

type DeviceApiPutDeviceTagIdResourceOpts 

type DeviceApiPutDeviceTagIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiPutIpmiDevicesThresholdsIdResourceOpts 

type DeviceApiPutIpmiDevicesThresholdsIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiPutIpmiThresholdsIdResourceOpts 

type DeviceApiPutIpmiThresholdsIdResourceOpts struct {
	XFields optional.String
}

type DeviceApiService 

type DeviceApiService service

func (*DeviceApiService) DeleteDeviceBondResource 

func (a *DeviceApiService) DeleteDeviceBondResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiDeleteDeviceBondResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*DeviceApiService) GetAllDeviceTagOrderResource 

func (a *DeviceApiService) GetAllDeviceTagOrderResource(ctx context.Context, localVarOptionals *DeviceApiGetAllDeviceTagOrderResourceOpts) (DeviceTag, *http.Response, error)

func (*DeviceApiService) GetClientDeviceTagOrderResource 

func (a *DeviceApiService) GetClientDeviceTagOrderResource(ctx context.Context, localVarOptionals *DeviceApiGetClientDeviceTagOrderResourceOpts) (DeviceTag, *http.Response, error)

func (*DeviceApiService) GetClientDeviceTagResource 

func (a *DeviceApiService) GetClientDeviceTagResource(ctx context.Context, localVarOptionals *DeviceApiGetClientDeviceTagResourceOpts) (DeviceTag, *http.Response, error)

func (*DeviceApiService) GetDeviceIdEventResource 

func (a *DeviceApiService) GetDeviceIdEventResource(ctx context.Context, deviceId string, localVarOptionals *DeviceApiGetDeviceIdEventResourceOpts) ([]DeviceEvent, *http.Response, error)

func (*DeviceApiService) GetDeviceIdResource 

func (a *DeviceApiService) GetDeviceIdResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetDeviceIdResourceOpts) (DeviceDump, *http.Response, error)

func (*DeviceApiService) GetDeviceIdServiceResource 

func (a *DeviceApiService) GetDeviceIdServiceResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetDeviceIdServiceResourceOpts) (Services, *http.Response, error)

func (*DeviceApiService) GetDeviceIpAssignmentsResource 

func (a *DeviceApiService) GetDeviceIpAssignmentsResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetDeviceIpAssignmentsResourceOpts) ([]IpAssignment, *http.Response, error)

func (*DeviceApiService) GetDeviceIpminatRuleResource 

func (a *DeviceApiService) GetDeviceIpminatRuleResource(ctx context.Context, deviceId int32) (*http.Response, error)

DeviceApiService Clear IPMI whitelist

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId ID of a client Device

func (*DeviceApiService) GetDevicePaymentMethodLinkedResource added in v0.2.0 

func (a *DeviceApiService) GetDevicePaymentMethodLinkedResource(ctx context.Context, billingInfoId int32, localVarOptionals *DeviceApiGetDevicePaymentMethodLinkedResourceOpts) ([]DeviceDump, *http.Response, error)

func (*DeviceApiService) GetDevicePortResource 

func (a *DeviceApiService) GetDevicePortResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetDevicePortResourceOpts) ([]DevicePort, *http.Response, error)

func (*DeviceApiService) GetDeviceResource 

func (a *DeviceApiService) GetDeviceResource(ctx context.Context, localVarOptionals *DeviceApiGetDeviceResourceOpts) ([]DeviceDump, *http.Response, error)

func (*DeviceApiService) GetDeviceTagIdResource 

func (a *DeviceApiService) GetDeviceTagIdResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetDeviceTagIdResourceOpts) (DeviceTag, *http.Response, error)

func (*DeviceApiService) GetEffectiveIgnitionIdResource 

func (a *DeviceApiService) GetEffectiveIgnitionIdResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetEffectiveIgnitionIdResourceOpts) (EffectiveIgnitionResponse, *http.Response, error)

func (*DeviceApiService) GetInitialCredsIdResource 

func (a *DeviceApiService) GetInitialCredsIdResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetInitialCredsIdResourceOpts) (DeviceInitialCreds, *http.Response, error)

func (*DeviceApiService) GetInitialPasswordIdResource 

func (a *DeviceApiService) GetInitialPasswordIdResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetInitialPasswordIdResourceOpts) (DevicePassword, *http.Response, error)

func (*DeviceApiService) GetIpmiInfoIdResource 

func (a *DeviceApiService) GetIpmiInfoIdResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetIpmiInfoIdResourceOpts) (DeviceIpmiInfo, *http.Response, error)

func (*DeviceApiService) GetIpmiInfoLoginDataResource 

func (a *DeviceApiService) GetIpmiInfoLoginDataResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetIpmiInfoLoginDataResourceOpts) (IpmiLoginData, *http.Response, error)

func (*DeviceApiService) GetIpmiThresholdsIdResource 

func (a *DeviceApiService) GetIpmiThresholdsIdResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetIpmiThresholdsIdResourceOpts) (DeviceIpmiThresholds, *http.Response, error)

func (*DeviceApiService) GetIpmiValidLoginIdResource 

func (a *DeviceApiService) GetIpmiValidLoginIdResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetIpmiValidLoginIdResourceOpts) (IpmiValidLogin, *http.Response, error)

func (*DeviceApiService) GetPowerResource 

func (a *DeviceApiService) GetPowerResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiGetPowerResourceOpts) (DevicePower, *http.Response, error)

func (*DeviceApiService) PostDeviceBondResource 

func (a *DeviceApiService) PostDeviceBondResource(ctx context.Context, deviceId int32, localVarOptionals *DeviceApiPostDeviceBondResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*DeviceApiService) PostDeviceIpmiWhitelistResource 

func (a *DeviceApiService) PostDeviceIpmiWhitelistResource(ctx context.Context, deviceId int32, payload DeviceIpmiWhitelistIp) (*http.Response, error)

DeviceApiService Whitelist IP for IPMI

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId ID of the Device to put IP in Whitelist
  • @param payload

func (*DeviceApiService) PostDevicePortIdClearResource 

func (a *DeviceApiService) PostDevicePortIdClearResource(ctx context.Context, deviceId int32, portId int32, localVarOptionals *DeviceApiPostDevicePortIdClearResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*DeviceApiService) PostDeviceReloadResource 

func (a *DeviceApiService) PostDeviceReloadResource(ctx context.Context, deviceId int32, payload DeviceReload, localVarOptionals *DeviceApiPostDeviceReloadResourceOpts) (ServiceOption, *http.Response, error)

func (*DeviceApiService) PostPowerResource 

func (a *DeviceApiService) PostPowerResource(ctx context.Context, deviceId int32, action string, localVarOptionals *DeviceApiPostPowerResourceOpts) (DevicePower, *http.Response, error)

func (*DeviceApiService) PostPreviewEffectiveIgnitionResource 

func (a *DeviceApiService) PostPreviewEffectiveIgnitionResource(ctx context.Context, payload PreviewEffectiveIgnition, localVarOptionals *DeviceApiPostPreviewEffectiveIgnitionResourceOpts) (PreviewEffectiveIgnitionResponse, *http.Response, error)

func (*DeviceApiService) PutClientDeviceTagOrderResource 

func (a *DeviceApiService) PutClientDeviceTagOrderResource(ctx context.Context, payload DeviceTag, localVarOptionals *DeviceApiPutClientDeviceTagOrderResourceOpts) (DeviceTag, *http.Response, error)

func (*DeviceApiService) PutDeviceIdResource 

func (a *DeviceApiService) PutDeviceIdResource(ctx context.Context, deviceId int32, payload DeviceUpdate, localVarOptionals *DeviceApiPutDeviceIdResourceOpts) (DeviceDump, *http.Response, error)

func (*DeviceApiService) PutDevicePortResource 

func (a *DeviceApiService) PutDevicePortResource(ctx context.Context, deviceId int32, payload DevicePortsUpdate, localVarOptionals *DeviceApiPutDevicePortResourceOpts) ([]NetworkTaskDump, *http.Response, error)

func (*DeviceApiService) PutDeviceTagIdResource 

func (a *DeviceApiService) PutDeviceTagIdResource(ctx context.Context, deviceId int32, payload DeviceTag, localVarOptionals *DeviceApiPutDeviceTagIdResourceOpts) (DeviceTag, *http.Response, error)

func (*DeviceApiService) PutIpmiDevicesThresholdsIdResource 

func (a *DeviceApiService) PutIpmiDevicesThresholdsIdResource(ctx context.Context, payload UpdateDevicesIpmiThresholds, localVarOptionals *DeviceApiPutIpmiDevicesThresholdsIdResourceOpts) (DevicesIpmiThresholds, *http.Response, error)

func (*DeviceApiService) PutIpmiThresholdsIdResource 

func (a *DeviceApiService) PutIpmiThresholdsIdResource(ctx context.Context, deviceId int32, payload DeviceIpmiThresholds, localVarOptionals *DeviceApiPutIpmiThresholdsIdResourceOpts) (DeviceIpmiThresholds, *http.Response, error)

type DeviceDump 

type DeviceDump struct {
	// The unique ID of the device.
	DeviceId int32 `json:"deviceId,omitempty"`
	// User given custom name.
	Name string `json:"name"`
	// active|inactive
	Status string `json:"status,omitempty"`
	// Generic description of device. Usually type and rack unit size.
	DeviceType string `json:"deviceType,omitempty"`
	// Generic group
	DeviceTypeGroup string `json:"deviceTypeGroup,omitempty"`
	// ON|OFF
	PowerStatus interface{} `json:"powerStatus,omitempty"`
	// True if device has active cancellation request.
	HasCancellation bool `json:"hasCancellation,omitempty"`
	// Device's service billing status.
	BillingStatus string `json:"billingStatus,omitempty"`
	// Device's service expected cancel date.
	BillingCancelDate int32 `json:"billingCancelDate,omitempty"`
	// True if device enrolled in managed services.
	IsManaged bool `json:"isManaged,omitempty"`
	// True if device currently reloading.
	IsReload bool `json:"isReload,omitempty"`
	// # of passing device monitors
	MonitorsUp int32 `json:"monitorsUp,omitempty"`
	// Total # device monitors
	MonitorsTotal int32 `json:"monitorsTotal,omitempty"`
	// # of managed service alerts.
	ManagedAlertsTotal int32 `json:"managedAlertsTotal,omitempty"`
	// Device Ports (Network Interfaces).
	Ports []interface{} `json:"ports,omitempty"`
	// a fqdn for the device. for example: `example.hivelocity.net`.
	Hostname string `json:"hostname,omitempty"`
	// True if device is accessible over IPMI by customer.
	IpmiEnabled bool `json:"ipmiEnabled,omitempty"`
	// List containing key/values of device info based on tag order.
	DisplayedTags []interface{} `json:"displayedTags,omitempty"`
	// List of all user set device tags.
	Tags []string `json:"tags,omitempty"`
	// Detailed information on the device location.
	Location interface{} `json:"location,omitempty"`
	// Network Automation status for device.
	NetworkAutomation interface{} `json:"networkAutomation,omitempty"`
	// The first assigned public IP for accessing this device.
	PrimaryIp string `json:"primaryIp,omitempty"`
	// IP address for IPMI connection. Requires you to whitelist your current IP or be on IPMI VPN.
	IpmiAddress     interface{} `json:"ipmiAddress,omitempty"`
	ServiceMonitors []string    `json:"serviceMonitors,omitempty"`
	// If set, detailed info on this device's billing method. Otherwise null. When null the accounts default billing info is used for payments.
	BillingInfo interface{} `json:"billingInfo,omitempty"`
	// The unique ID of the associated service.
	ServicePlan int32 `json:"servicePlan,omitempty"`
	// The unique ID of the last invoice for this device.
	LastInvoiceId int32 `json:"lastInvoiceId,omitempty"`
	// True if instant server.
	SelfProvisioning bool `json:"selfProvisioning,omitempty"`
	// Additional metadata.
	Metadata interface{} `json:"metadata,omitempty"`
	// BUILDING|IPMI_READY|PROVISIONABLE|RESERVED|WAIT_FOR_PXE|PROVISION_STARTED|PROVISION_WAIT_FOR_ADDONS|PROVISION_FINISHED|WAIT_TO_COMPLETE_ORDER|WAIT_TO_ASSIGN_SERVICE|WAIT_FOR_HARDWARE_SCAN|IN_USE|RELOADING|DEVICE_READY_TO_TEST|DEVICE_READY_TO_WIPE|DEVICE_READY_TO_UPGRADE_FIRMWARE|FAILED|CLEANUP_MOVE_TO_FAILED|IN_REVIEW|READY_FOR_MIGRATION
	SpsStatus string `json:"spsStatus,omitempty"`
	// The unique ID of the associated client.
	ClientId int32 `json:"clientId,omitempty"`
}

type DeviceEvent 

type DeviceEvent struct {
	Time   int32  `json:"time,omitempty"`
	Action string `json:"action,omitempty"`
}

type DeviceInitialCreds 

type DeviceInitialCreds struct {
	// Date password will expire from API.
	PasswordReturnsUntil int32 `json:"passwordReturnsUntil,omitempty"`
	// Password for initial ssh access. Will expire from api 7 days after initial provision.
	Password string `json:"password,omitempty"`
	// Port for initial ssh access.
	Port int32 `json:"port,omitempty"`
	// Link to encrypted locker containing password for initial ssh access. Locker contents be expired from api 7 days after initial provision.
	LockerUrl string `json:"lockerUrl,omitempty"`
	// User for initial ssh access.
	User string `json:"user,omitempty"`
}

type DeviceIpmiInfo 

type DeviceIpmiInfo struct {
	Info    *IpmiInfo    `json:"info,omitempty"`
	Sensors []IpmiSensor `json:"sensors,omitempty"`
}

type DeviceIpmiThresholds 

type DeviceIpmiThresholds struct {
	// Alert thresholds for IPMI sensor values.
	Thresholds interface{} `json:"thresholds"`
}

type DeviceIpmiWhitelistIp 

type DeviceIpmiWhitelistIp struct {
	CustIp string `json:"custIp"`
}

type DevicePassword 

type DevicePassword struct {
	// Password for initial ssh access. Will be deleted from api 7 days after initial provision.
	Password string `json:"password"`
}

type DevicePort 

type DevicePort struct {
	Private bool `json:"private"`
	// The unique ID of the port.
	PortId int32 `json:"portId,omitempty"`
	// The vlan tag of the port's native vlan, if applicable.
	NativeVlanTag int32 `json:"nativeVlanTag,omitempty"`
	// ENABLED|DISABLED|UNKOWN
	Status string `json:"status,omitempty"`
	// Indicates if is a bond interface. If not, indicates the Mbps rate of the port.
	Type_ string `json:"type,omitempty"`
	// The unique ID of the native VLAN, if applicable.
	NativeVlanId int32  `json:"nativeVlanId,omitempty"`
	Name         string `json:"name,omitempty"`
	// Your client account's unique ID.
	ClientId int32 `json:"clientId,omitempty"`
	// The unique ID of the port's device.
	DeviceId int32 `json:"deviceId,omitempty"`
	// IPs applied to this port.
	Ips []IpAssignment `json:"ips,omitempty"`
	Mtu int32          `json:"mtu,omitempty"`
}

type DevicePortUpdate 

type DevicePortUpdate struct {
	// The unique ID of the port.
	PortId  int32 `json:"portId"`
	Enabled bool  `json:"enabled,omitempty"`
	// IP Assignments IDs currently routed to this port.
	IpAssignments []int32 `json:"ipAssignments"`
	// The unique ID of the port's native vlan, if applicable. Send value `0` to remove the native vlan from this port.
	NativeVlanId int32 `json:"nativeVlanId,omitempty"`
}

type DevicePortsUpdate 

type DevicePortsUpdate struct {
	Ports []DevicePortUpdate `json:"ports,omitempty"`
}

type DevicePower 

type DevicePower struct {
	// ON|OFF
	PowerStatus string `json:"powerStatus"`
}

type DeviceReload 

type DeviceReload struct {
	// The unique ID of the control panel product option to provision on this device. This is used only for custom devices.
	ControlPanelId int32 `json:"controlPanelId,omitempty"`
	// The unique ID of an Ignition File for FlatcarOS provisions.
	IgnitionId int32 `json:"ignitionId,omitempty"`
	// List of public ssh keys
	PublicSshKeyIds []int32 `json:"publicSshKeyIds,omitempty"`
	// Describe any special requests for custom devices.
	Body string `json:"body,omitempty"`
	// The unique ID of the operating system product option to provision on this device.
	OperatingSystemId int32 `json:"operatingSystemId"`
	// Custom IPXE script URL. If device was provisioned was one before and this field is omitted, the original custom iPXE script is used. Otherwise specifying the script will override.
	CustomIPXEScriptUrl string `json:"customIPXEScriptUrl,omitempty"`
	// A Cloud-Init script or a post-install script (Bash for Linux or Powershell for Windows).
	Script string `json:"script,omitempty"`
}

type DeviceTag 

type DeviceTag struct {
	// List of user set device tags.
	Tags []string `json:"tags,omitempty"`
}

type DeviceUpdate 

type DeviceUpdate struct {
	Name string `json:"name,omitempty"`
	// A FQDN for the device. For example: `example.hivelocity.net`.
	Hostname string `json:"hostname,omitempty"`
}

type DevicesIpmiThresholds 

type DevicesIpmiThresholds struct {
	Devices interface{} `json:"devices"`
}

type DomainCreate 

type DomainCreate struct {
	Name string `json:"name"`
}

type DomainReturn 

type DomainReturn struct {
	Name      string      `json:"name"`
	Summary   interface{} `json:"summary,omitempty"`
	DirectsTo string      `json:"directsTo"`
	DomainId  int32       `json:"domainId"`
}

type DomainsApiGetARecordIdResourceOpts 

type DomainsApiGetARecordIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetARecordResourceOpts 

type DomainsApiGetARecordResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetAaaaRecordIdResourceOpts 

type DomainsApiGetAaaaRecordIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetAaaaRecordResourceOpts 

type DomainsApiGetAaaaRecordResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetDomainIdResourceOpts 

type DomainsApiGetDomainIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetDomainResourceOpts 

type DomainsApiGetDomainResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetMxRecordIdResourceOpts 

type DomainsApiGetMxRecordIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetMxRecordResourceOpts 

type DomainsApiGetMxRecordResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetPtrRecordIdResourceOpts 

type DomainsApiGetPtrRecordIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiGetPtrRecordResourceOpts 

type DomainsApiGetPtrRecordResourceOpts struct {
	XFields optional.String
}

type DomainsApiPostARecordResourceOpts 

type DomainsApiPostARecordResourceOpts struct {
	XFields optional.String
}

type DomainsApiPostAaaaRecordResourceOpts 

type DomainsApiPostAaaaRecordResourceOpts struct {
	XFields optional.String
}

type DomainsApiPostDomainResourceOpts 

type DomainsApiPostDomainResourceOpts struct {
	XFields optional.String
}

type DomainsApiPostMxRecordResourceOpts 

type DomainsApiPostMxRecordResourceOpts struct {
	XFields optional.String
}

type DomainsApiPutARecordIdResourceOpts 

type DomainsApiPutARecordIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiPutAaaaRecordIdResourceOpts 

type DomainsApiPutAaaaRecordIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiPutMxRecordIdResourceOpts 

type DomainsApiPutMxRecordIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiPutPtrRecordIdResourceOpts 

type DomainsApiPutPtrRecordIdResourceOpts struct {
	XFields optional.String
}

type DomainsApiService 

type DomainsApiService service

func (*DomainsApiService) DeleteARecordIdResource 

func (a *DomainsApiService) DeleteARecordIdResource(ctx context.Context, domain string, record string) (*http.Response, error)

DomainsApiService Delete a single A Record value for given zone

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param domain
  • @param record

func (*DomainsApiService) DeleteAaaaRecordIdResource 

func (a *DomainsApiService) DeleteAaaaRecordIdResource(ctx context.Context, domainID int32, recordId int32) (*http.Response, error)

DomainsApiService Delete an AAAA Record for given zone

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param domainID
  • @param recordId

func (*DomainsApiService) DeleteDomainIdResource 

func (a *DomainsApiService) DeleteDomainIdResource(ctx context.Context, domainId int32) (*http.Response, error)

DomainsApiService Delete domain for given id

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param domainId

func (*DomainsApiService) DeleteMxRecordIdResource 

func (a *DomainsApiService) DeleteMxRecordIdResource(ctx context.Context, domainID int32, recordId int32) (*http.Response, error)

DomainsApiService Delete an MX Record for given zone

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param domainID
  • @param recordId

func (*DomainsApiService) GetARecordIdResource 

func (a *DomainsApiService) GetARecordIdResource(ctx context.Context, domain string, record string, localVarOptionals *DomainsApiGetARecordIdResourceOpts) (ARecord, *http.Response, error)

func (*DomainsApiService) GetARecordResource 

func (a *DomainsApiService) GetARecordResource(ctx context.Context, domain string, localVarOptionals *DomainsApiGetARecordResourceOpts) ([]ARecord, *http.Response, error)

func (*DomainsApiService) GetAaaaRecordIdResource 

func (a *DomainsApiService) GetAaaaRecordIdResource(ctx context.Context, domainID int32, recordId int32, localVarOptionals *DomainsApiGetAaaaRecordIdResourceOpts) (AaaaRecordReturn, *http.Response, error)

func (*DomainsApiService) GetAaaaRecordResource 

func (a *DomainsApiService) GetAaaaRecordResource(ctx context.Context, domainID int32, localVarOptionals *DomainsApiGetAaaaRecordResourceOpts) ([]AaaaRecordReturn, *http.Response, error)

func (*DomainsApiService) GetDomainIdResource 

func (a *DomainsApiService) GetDomainIdResource(ctx context.Context, domainId int32, localVarOptionals *DomainsApiGetDomainIdResourceOpts) (DomainReturn, *http.Response, error)

func (*DomainsApiService) GetDomainResource 

func (a *DomainsApiService) GetDomainResource(ctx context.Context, localVarOptionals *DomainsApiGetDomainResourceOpts) ([]DomainReturn, *http.Response, error)

func (*DomainsApiService) GetMxRecordIdResource 

func (a *DomainsApiService) GetMxRecordIdResource(ctx context.Context, domainID int32, recordId int32, localVarOptionals *DomainsApiGetMxRecordIdResourceOpts) (MxRecordReturn, *http.Response, error)

func (*DomainsApiService) GetMxRecordResource 

func (a *DomainsApiService) GetMxRecordResource(ctx context.Context, domainID int32, localVarOptionals *DomainsApiGetMxRecordResourceOpts) ([]MxRecordReturn, *http.Response, error)

func (*DomainsApiService) GetPtrRecordIdResource 

func (a *DomainsApiService) GetPtrRecordIdResource(ctx context.Context, recordId int32, localVarOptionals *DomainsApiGetPtrRecordIdResourceOpts) (PtrRecordReturn, *http.Response, error)

func (*DomainsApiService) GetPtrRecordResource 

func (a *DomainsApiService) GetPtrRecordResource(ctx context.Context, localVarOptionals *DomainsApiGetPtrRecordResourceOpts) ([]PtrRecordReturn, *http.Response, error)

func (*DomainsApiService) PostARecordResource 

func (a *DomainsApiService) PostARecordResource(ctx context.Context, domain string, payload ARecord, localVarOptionals *DomainsApiPostARecordResourceOpts) (ARecord, *http.Response, error)

func (*DomainsApiService) PostAaaaRecordResource 

func (a *DomainsApiService) PostAaaaRecordResource(ctx context.Context, domainID int32, payload AaaaRecordCreate, localVarOptionals *DomainsApiPostAaaaRecordResourceOpts) (AaaaRecordReturn, *http.Response, error)

func (*DomainsApiService) PostDomainResource 

func (a *DomainsApiService) PostDomainResource(ctx context.Context, payload DomainCreate, localVarOptionals *DomainsApiPostDomainResourceOpts) (DomainReturn, *http.Response, error)

func (*DomainsApiService) PostMxRecordResource 

func (a *DomainsApiService) PostMxRecordResource(ctx context.Context, domainID int32, payload MxRecordCreate, localVarOptionals *DomainsApiPostMxRecordResourceOpts) (MxRecordReturn, *http.Response, error)

func (*DomainsApiService) PutARecordIdResource 

func (a *DomainsApiService) PutARecordIdResource(ctx context.Context, domain string, record string, payload ARecord, localVarOptionals *DomainsApiPutARecordIdResourceOpts) (ARecord, *http.Response, error)

func (*DomainsApiService) PutAaaaRecordIdResource 

func (a *DomainsApiService) PutAaaaRecordIdResource(ctx context.Context, domainID int32, recordId int32, payload AaaaRecordUpdate, localVarOptionals *DomainsApiPutAaaaRecordIdResourceOpts) (AaaaRecordReturn, *http.Response, error)

func (*DomainsApiService) PutMxRecordIdResource 

func (a *DomainsApiService) PutMxRecordIdResource(ctx context.Context, domainID int32, recordId int32, payload MxRecordUpdate, localVarOptionals *DomainsApiPutMxRecordIdResourceOpts) (MxRecordReturn, *http.Response, error)

func (*DomainsApiService) PutPtrRecordIdResource 

func (a *DomainsApiService) PutPtrRecordIdResource(ctx context.Context, recordId int32, payload PtrRecordUpdate, localVarOptionals *DomainsApiPutPtrRecordIdResourceOpts) (PtrRecordReturn, *http.Response, error)

type EffectiveIgnitionResponse 

type EffectiveIgnitionResponse struct {
	Contents string `json:"contents"`
}

type FastServiceDump 

type FastServiceDump struct {
	ServiceId                int32               `json:"serviceId,omitempty"`
	Created                  int32               `json:"created,omitempty"`
	BilledPrice              float32             `json:"billedPrice,omitempty"`
	BilledPricePerPeriod     float32             `json:"billedPricePerPeriod,omitempty"`
	ServiceCost              float32             `json:"serviceCost,omitempty"`
	LastRenew                int32               `json:"lastRenew,omitempty"`
	RenewDate                int32               `json:"renewDate,omitempty"`
	Quantity                 float32             `json:"quantity,omitempty"`
	OrderId                  int32               `json:"orderId,omitempty"`
	Status                   string              `json:"status,omitempty"`
	Period                   string              `json:"period,omitempty"`
	Discount                 float32             `json:"discount,omitempty"`
	DiscountType             string              `json:"discountType,omitempty"`
	DiscountedCost           float32             `json:"discountedCost,omitempty"`
	ServiceDiscount          float32             `json:"serviceDiscount,omitempty"`
	ServiceDiscountPerPeriod float32             `json:"serviceDiscountPerPeriod,omitempty"`
	IpAddress                string              `json:"ipAddress,omitempty"`
	CancelAfter              int32               `json:"cancelAfter,omitempty"`
	StartDate                int32               `json:"startDate,omitempty"`
	EndDate                  int32               `json:"endDate,omitempty"`
	ServiceOptions           []ServiceOptionData `json:"serviceOptions,omitempty"`
	Usage                    interface{}         `json:"usage,omitempty"`
	ServiceDevices           []interface{}       `json:"serviceDevices,omitempty"`
	ChildServices            []interface{}       `json:"childServices,omitempty"`
	ProductId                int32               `json:"productId,omitempty"`
	ProductName              string              `json:"productName,omitempty"`
	Reseller                 string              `json:"reseller,omitempty"`
	ServiceType              string              `json:"serviceType,omitempty"`
	ContractTerm             int32               `json:"contractTerm,omitempty"`
	BillingInfoId            int32               `json:"billingInfoId,omitempty"`
	AutoBill                 bool                `json:"autoBill,omitempty"`
	ColocationCharge         float32             `json:"colocationCharge,omitempty"`
	ResellerBmaasCharge      float32             `json:"resellerBmaasCharge,omitempty"`
	FacilityName             string              `json:"facilityName,omitempty"`
	// The service type code. The list of service types can be accessed on https://core.hivelocity.net/api/v2/service/types .
	TypeCode         string                   `json:"typeCode,omitempty"`
	BandwidthBilling *ServiceBandwidthBilling `json:"bandwidthBilling,omitempty"`
	Acquisition      string                   `json:"acquisition,omitempty"`
}

type GenericSwaggerError 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type IPAssignmentApiGetIpAssignmentIdResourceOpts 

type IPAssignmentApiGetIpAssignmentIdResourceOpts struct {
	XFields optional.String
}

type IPAssignmentApiGetIpAssignmentResourceOpts 

type IPAssignmentApiGetIpAssignmentResourceOpts struct {
	DisplayPrivateNetworks optional.Bool
	DisplayIPv6            optional.Bool
	ClientId               optional.Int32
	XFields                optional.String
}

type IPAssignmentApiGetIpAssignmentSubnetResourceOpts 

type IPAssignmentApiGetIpAssignmentSubnetResourceOpts struct {
	XFields optional.String
}

type IPAssignmentApiPostIpAssignmentCombineResourceOpts 

type IPAssignmentApiPostIpAssignmentCombineResourceOpts struct {
	XFields optional.String
}

type IPAssignmentApiPostIpAssignmentIdClearResourceOpts 

type IPAssignmentApiPostIpAssignmentIdClearResourceOpts struct {
	XFields optional.String
}

type IPAssignmentApiPostIpAssignmentSplitResourceOpts 

type IPAssignmentApiPostIpAssignmentSplitResourceOpts struct {
	XFields optional.String
}

type IPAssignmentApiPutIpAssignmentIdResourceOpts 

type IPAssignmentApiPutIpAssignmentIdResourceOpts struct {
	XFields optional.String
}

type IPAssignmentApiService 

type IPAssignmentApiService service

func (*IPAssignmentApiService) DeleteIpAssignmentIdResource 

func (a *IPAssignmentApiService) DeleteIpAssignmentIdResource(ctx context.Context, ipAssignmentId int32) (*http.Response, error)

IPAssignmentApiService Delete assignment

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param ipAssignmentId

func (*IPAssignmentApiService) GetIpAssignmentIdResource 

func (a *IPAssignmentApiService) GetIpAssignmentIdResource(ctx context.Context, ipAssignmentId int32, localVarOptionals *IPAssignmentApiGetIpAssignmentIdResourceOpts) (IpAssignment, *http.Response, error)

func (*IPAssignmentApiService) GetIpAssignmentResource 

func (a *IPAssignmentApiService) GetIpAssignmentResource(ctx context.Context, localVarOptionals *IPAssignmentApiGetIpAssignmentResourceOpts) ([]IpAssignment, *http.Response, error)

func (*IPAssignmentApiService) GetIpAssignmentSubnetResource 

func (a *IPAssignmentApiService) GetIpAssignmentSubnetResource(ctx context.Context, ipAddress string, localVarOptionals *IPAssignmentApiGetIpAssignmentSubnetResourceOpts) (IpAssignment, *http.Response, error)

func (*IPAssignmentApiService) PostIpAssignmentCombineResource 

func (a *IPAssignmentApiService) PostIpAssignmentCombineResource(ctx context.Context, payload IpAssignmentCombine, localVarOptionals *IPAssignmentApiPostIpAssignmentCombineResourceOpts) (IpAssignment, *http.Response, error)

func (*IPAssignmentApiService) PostIpAssignmentIdClearResource 

func (a *IPAssignmentApiService) PostIpAssignmentIdClearResource(ctx context.Context, ipAssignmentId int32, localVarOptionals *IPAssignmentApiPostIpAssignmentIdClearResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*IPAssignmentApiService) PostIpAssignmentResource 

func (a *IPAssignmentApiService) PostIpAssignmentResource(ctx context.Context, payload IpAssignmentRequest) (*http.Response, error)

IPAssignmentApiService Request new assignment This endpoint is used to request a new IP Assignment from MyV and the API itself. It will create a request on Zendesk for Networking support team.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param payload

func (*IPAssignmentApiService) PostIpAssignmentSplitResource 

func (a *IPAssignmentApiService) PostIpAssignmentSplitResource(ctx context.Context, ipAssignmentId int32, localVarOptionals *IPAssignmentApiPostIpAssignmentSplitResourceOpts) ([]IpAssignment, *http.Response, error)

func (*IPAssignmentApiService) PutIpAssignmentIdResource 

func (a *IPAssignmentApiService) PutIpAssignmentIdResource(ctx context.Context, ipAssignmentId int32, payload IpAssignmentPut, localVarOptionals *IPAssignmentApiPutIpAssignmentIdResourceOpts) (NetworkTaskDump, *http.Response, error)

type IgnitionApiDeleteIgnitionResourceIdOpts 

type IgnitionApiDeleteIgnitionResourceIdOpts struct {
	XFields optional.String
}

type IgnitionApiGetIgnitionResourceIdOpts 

type IgnitionApiGetIgnitionResourceIdOpts struct {
	XFields optional.String
}

type IgnitionApiGetIgnitionResourceOpts 

type IgnitionApiGetIgnitionResourceOpts struct {
	XFields optional.String
}

type IgnitionApiPostIgnitionResourceOpts 

type IgnitionApiPostIgnitionResourceOpts struct {
	XFields optional.String
}

type IgnitionApiPutIgnitionResourceIdOpts 

type IgnitionApiPutIgnitionResourceIdOpts struct {
	XFields optional.String
}

type IgnitionApiService 

type IgnitionApiService service

func (*IgnitionApiService) DeleteIgnitionResourceId 

func (a *IgnitionApiService) DeleteIgnitionResourceId(ctx context.Context, ignitionId int32, localVarOptionals *IgnitionApiDeleteIgnitionResourceIdOpts) (*http.Response, error)

func (*IgnitionApiService) GetIgnitionResource 

func (a *IgnitionApiService) GetIgnitionResource(ctx context.Context, localVarOptionals *IgnitionApiGetIgnitionResourceOpts) ([]IgnitionResponse, *http.Response, error)

func (*IgnitionApiService) GetIgnitionResourceId 

func (a *IgnitionApiService) GetIgnitionResourceId(ctx context.Context, ignitionId int32, localVarOptionals *IgnitionApiGetIgnitionResourceIdOpts) (IgnitionResponse, *http.Response, error)

func (*IgnitionApiService) PostIgnitionResource 

func (a *IgnitionApiService) PostIgnitionResource(ctx context.Context, payload CreateIgnition, localVarOptionals *IgnitionApiPostIgnitionResourceOpts) (IgnitionResponse, *http.Response, error)

func (*IgnitionApiService) PutIgnitionResourceId 

func (a *IgnitionApiService) PutIgnitionResourceId(ctx context.Context, ignitionId int32, payload UpdateIgnition, localVarOptionals *IgnitionApiPutIgnitionResourceIdOpts) (IgnitionResponse, *http.Response, error)

type IgnitionResponse 

type IgnitionResponse struct {
	Name     string `json:"name,omitempty"`
	Contents string `json:"contents,omitempty"`
	Id       int32  `json:"id,omitempty"`
}

type Inventory 

type Inventory struct {
}

type InventoryApiGetLocationResourceOpts 

type InventoryApiGetLocationResourceOpts struct {
	VpsLocations optional.String
	XFields      optional.String
}

type InventoryApiGetStockByProductResourceOpts 

type InventoryApiGetStockByProductResourceOpts struct {
	XFields optional.String
}

type InventoryApiGetStockResourceOpts 

type InventoryApiGetStockResourceOpts struct {
	Location       optional.String
	IncludeCustom  optional.Bool
	BondingSupport optional.String
	GroupBy        optional.String
}

type InventoryApiService 

type InventoryApiService service

func (*InventoryApiService) GetLocationResource 

func (a *InventoryApiService) GetLocationResource(ctx context.Context, localVarOptionals *InventoryApiGetLocationResourceOpts) ([]Location, *http.Response, error)

func (*InventoryApiService) GetStockByProductResource 

func (a *InventoryApiService) GetStockByProductResource(ctx context.Context, productId int32, localVarOptionals *InventoryApiGetStockByProductResourceOpts) (Stock, *http.Response, error)

func (*InventoryApiService) GetStockResource 

func (a *InventoryApiService) GetStockResource(ctx context.Context, localVarOptionals *InventoryApiGetStockResourceOpts) (Inventory, *http.Response, error)

type Invoice 

type Invoice struct {
	Id           int32   `json:"id,omitempty"`
	Amount       float32 `json:"amount,omitempty"`
	AmountUnpaid float32 `json:"amountUnpaid,omitempty"`
	ClientId     int32   `json:"clientId,omitempty"`
	Created      int32   `json:"created,omitempty"`
	DatePaid     int32   `json:"datePaid,omitempty"`
	Due          int32   `json:"due,omitempty"`
	Sent         int32   `json:"sent,omitempty"`
	Status       string  `json:"status,omitempty"`
}

type InvoiceApiGetInvoiceIdDetailsOpts 

type InvoiceApiGetInvoiceIdDetailsOpts struct {
	XFields optional.String
}

type InvoiceApiGetInvoiceIdResourceOpts 

type InvoiceApiGetInvoiceIdResourceOpts struct {
	XFields optional.String
}

type InvoiceApiGetInvoicePdfResourceOpts 

type InvoiceApiGetInvoicePdfResourceOpts struct {
	XFields optional.String
}

type InvoiceApiGetInvoiceResourceOpts 

type InvoiceApiGetInvoiceResourceOpts struct {
	XFields optional.String
}

type InvoiceApiGetInvoiceSearchResourceOpts 

type InvoiceApiGetInvoiceSearchResourceOpts struct {
	EndDate   optional.Int32
	StartDate optional.Int32
	PerPage   optional.Int32
	Page      optional.Int32
	Q         optional.String
	XFields   optional.String
}

type InvoiceApiGetInvoiceUnpaidResourceOpts 

type InvoiceApiGetInvoiceUnpaidResourceOpts struct {
	XFields optional.String
}

type InvoiceApiPostInvoiceIdApplyAccountCreditOpts added in v0.2.0 

type InvoiceApiPostInvoiceIdApplyAccountCreditOpts struct {
	XFields optional.String
}

type InvoiceApiService 

type InvoiceApiService service

func (*InvoiceApiService) GetInvoiceIdDetails 

func (a *InvoiceApiService) GetInvoiceIdDetails(ctx context.Context, invoiceId int32, localVarOptionals *InvoiceApiGetInvoiceIdDetailsOpts) (InvoiceDetails, *http.Response, error)

func (*InvoiceApiService) GetInvoiceIdResource 

func (a *InvoiceApiService) GetInvoiceIdResource(ctx context.Context, invoiceId int32, localVarOptionals *InvoiceApiGetInvoiceIdResourceOpts) (Invoice, *http.Response, error)

func (*InvoiceApiService) GetInvoicePdfResource 

func (a *InvoiceApiService) GetInvoicePdfResource(ctx context.Context, invoiceId int32, localVarOptionals *InvoiceApiGetInvoicePdfResourceOpts) (InvoicePdf, *http.Response, error)

func (*InvoiceApiService) GetInvoiceResource 

func (a *InvoiceApiService) GetInvoiceResource(ctx context.Context, localVarOptionals *InvoiceApiGetInvoiceResourceOpts) ([]Invoice, *http.Response, error)

func (*InvoiceApiService) GetInvoiceSearchResource 

func (a *InvoiceApiService) GetInvoiceSearchResource(ctx context.Context, localVarOptionals *InvoiceApiGetInvoiceSearchResourceOpts) (InvoiceSeachResult, *http.Response, error)

func (*InvoiceApiService) GetInvoiceUnpaidResource 

func (a *InvoiceApiService) GetInvoiceUnpaidResource(ctx context.Context, localVarOptionals *InvoiceApiGetInvoiceUnpaidResourceOpts) (InvoiceUnpaid, *http.Response, error)

func (*InvoiceApiService) PostInvoiceIdApplyAccountCredit added in v0.2.0 

func (a *InvoiceApiService) PostInvoiceIdApplyAccountCredit(ctx context.Context, invoiceId int32, localVarOptionals *InvoiceApiPostInvoiceIdApplyAccountCreditOpts) (Invoice, *http.Response, error)

type InvoiceDetails 

type InvoiceDetails struct {
	AccountBalance  float32                      `json:"accountBalance,omitempty"`
	ClientAddress   string                       `json:"clientAddress,omitempty"`
	ClientName      string                       `json:"clientName,omitempty"`
	CompanyName     string                       `json:"companyName,omitempty"`
	InvoiceDate     time.Time                    `json:"invoiceDate,omitempty"`
	InvoiceDue      time.Time                    `json:"invoiceDue,omitempty"`
	InvoiceNumber   string                       `json:"invoiceNumber,omitempty"`
	ServiceItems    []InvoiceDetailsServiceItems `json:"serviceItems,omitempty"`
	TaxesValue      float32                      `json:"taxesValue,omitempty"`
	TotalDue        float32                      `json:"totalDue,omitempty"`
	PaymentHistory  []interface{}                `json:"paymentHistory,omitempty"`
	RefundHistory   []interface{}                `json:"refundHistory,omitempty"`
	TaxesList       []interface{}                `json:"taxesList,omitempty"`
	PriorBalance    float32                      `json:"priorBalance,omitempty"`
	PaymentsRefunds float32                      `json:"paymentsRefunds,omitempty"`
}

type InvoiceDetailsServiceItems 

type InvoiceDetailsServiceItems struct {
	UnitPrice   float32     `json:"unitPrice,omitempty"`
	ServiceId   int32       `json:"serviceId,omitempty"`
	Description string      `json:"description,omitempty"`
	DateRange   interface{} `json:"dateRange,omitempty"`
	Quantity    int32       `json:"quantity,omitempty"`
}

type InvoicePdf 

type InvoicePdf struct {
	InvoiceId int32  `json:"invoiceId,omitempty"`
	PdfData   string `json:"pdfData,omitempty"`
}

type InvoiceSeachResult 

type InvoiceSeachResult struct {
	Pages    int32    `json:"pages,omitempty"`
	NextPage int32    `json:"nextPage,omitempty"`
	Items    *Invoice `json:"items,omitempty"`
	Page     int32    `json:"page,omitempty"`
	PrevPage int32    `json:"prevPage,omitempty"`
	HasNext  bool     `json:"hasNext,omitempty"`
	Total    int32    `json:"total,omitempty"`
	PerPage  int32    `json:"perPage,omitempty"`
	HasPrev  bool     `json:"hasPrev,omitempty"`
}

type InvoiceUnpaid 

type InvoiceUnpaid struct {
	AmountUnpaid float32 `json:"amountUnpaid,omitempty"`
}

type IpAssignment 

type IpAssignment struct {
	// IP version of this assignment (ipv4 or ipv6)
	Version int32 `json:"version"`
	// Unique ID of this assignment
	AssignmentId int32 `json:"assignmentId,omitempty"`
	// Unique ID of the assignment owner
	ClientId int32 `json:"clientId,omitempty"`
	// CIDR representation of this assignment.
	Subnet string `json:"subnet,omitempty"`
	// Netmask for this assignment.
	Netmask string `json:"netmask,omitempty"`
	// Broadcast address for this subnet.
	BroadcastIp string `json:"broadcastIp,omitempty"`
	// Gateway address for this subnet.
	GatewayIp string `json:"gatewayIp,omitempty"`
	// DNS resolvers for this subnet. Only applicable to VPS instances.
	DnsResolvers []string `json:"dnsResolvers,omitempty"`
	// First address available for use by Devices on this subnet.
	FirstUsableIp string `json:"firstUsableIp,omitempty"`
	// Last address available for use by Devices on this subnet.
	LastUsableIp string `json:"lastUsableIp,omitempty"`
	// A list of usable IP addresses on assignment. It is only filled for IPv4 subnets.
	UsableIps []string `json:"usableIps,omitempty"`
	// Facility code of this assignment.
	FacilityCode string `json:"facilityCode,omitempty"`
	// Description for this assignment.
	Description string `json:"description,omitempty"`
	// The device receiving traffic from the assignment.
	DeviceId int32 `json:"deviceId,omitempty"`
	// The port receiving traffic from the assignment.
	PortId int32 `json:"portId,omitempty"`
	// The VLAN receiving traffic from the assignment.
	VlanId int32 `json:"vlanId,omitempty"`
	// Next Hop IP address, if this assignment is statically routed.
	NextHopIp string `json:"nextHopIp,omitempty"`
}

type IpAssignmentCombine 

type IpAssignmentCombine struct {
	// List of Unique assignment IDs.
	AssignmentIds []int32 `json:"assignmentIds,omitempty"`
}

type IpAssignmentPut 

type IpAssignmentPut struct {
	// Route traffic from the IPs in the assignment to this IPv4 or IPv6 IP.
	NextHopIp string `json:"nextHopIp,omitempty"`
}

type IpAssignmentRequest 

type IpAssignmentRequest struct {
	// For example: `/27`.
	PrefixLength int32 `json:"prefixLength,omitempty"`
	// List the intended use of each IP in the subnet. Required by ICANN.
	Purpose string `json:"purpose,omitempty"`
	// For example: `NYC1`.
	FacilityCode string `json:"facilityCode,omitempty"`
}

type IpmiInfo 

type IpmiInfo struct {
	ManufacturerName   string `json:"manufacturerName,omitempty"`
	IpmbEventReceiver  string `json:"ipmbEventReceiver,omitempty"`
	ProductId          string `json:"productId,omitempty"`
	AuxFirmwareRevInfo string `json:"auxFirmwareRevInfo,omitempty"`
	DeviceSDRs         string `json:"deviceSDRs,omitempty"`
	SensorDevice       string `json:"sensorDevice,omitempty"`
	FruInventoryDevice string `json:"fruInventoryDevice,omitempty"`
	Bridge             string `json:"bridge,omitempty"`
	DeviceRevision     string `json:"deviceRevision,omitempty"`
	ChassisDevice      string `json:"chassisDevice,omitempty"`
	DeviceAvailable    string `json:"deviceAvailable,omitempty"`
	SelDevice          string `json:"selDevice,omitempty"`
	ManufacturerId     string `json:"manufacturerId,omitempty"`
	IpmiVersion        string `json:"ipmiVersion,omitempty"`
	// The IPMI ID of the device.
	DeviceId            string `json:"deviceId,omitempty"`
	IpmbEventGenerator  string `json:"ipmbEventGenerator,omitempty"`
	FirmwareRevision    string `json:"firmwareRevision,omitempty"`
	SdrRepositoryDevice string `json:"sdrRepositoryDevice,omitempty"`
}

type IpmiLoginData 

type IpmiLoginData struct {
	// Password for IPMI console.
	Password string `json:"password,omitempty"`
	// IP for IPMI access. Requires your current IP to be whitelisted or the IPMI VPN.
	Host string `json:"host,omitempty"`
	// Username for IPMI console.
	Username   string `json:"username,omitempty"`
	Drivertype string `json:"drivertype,omitempty"`
}

type IpmiSensor 

type IpmiSensor struct {
	Status   bool    `json:"status,omitempty"`
	Reading  float32 `json:"reading,omitempty"`
	Name     string  `json:"name,omitempty"`
	Group    string  `json:"group,omitempty"`
	Units    string  `json:"units,omitempty"`
	SensorId string  `json:"sensorId,omitempty"`
}

type IpmiValidLogin 

type IpmiValidLogin struct {
	Valid bool `json:"valid"`
}

type Location 

type Location struct {
	// The unique facility code.
	Code     string            `json:"code,omitempty"`
	Location *LocationLocation `json:"location,omitempty"`
	// true|false if core site.
	Core bool `json:"core,omitempty"`
	// The unique identifier for a facility
	Id int32 `json:"id,omitempty"`
	// The unique facility name.
	Title string `json:"title,omitempty"`
	// true|false if edge site.
	Edge bool `json:"edge,omitempty"`
	// Location option IDs of location
	LocationOptionIds []int32 `json:"location_option_ids,omitempty"`
}

type LocationLocation 

type LocationLocation struct {
}

JSON city info: city, state, & country.

type MaintenanceApiGetMaintenanceEventClientResourceOpts added in v0.2.0 

type MaintenanceApiGetMaintenanceEventClientResourceOpts struct {
	XFields optional.String
}

type MaintenanceApiGetMaintenanceEventIdClientResourceOpts added in v0.2.0 

type MaintenanceApiGetMaintenanceEventIdClientResourceOpts struct {
	XFields optional.String
}

type MaintenanceApiService added in v0.2.0 

type MaintenanceApiService service

func (*MaintenanceApiService) GetMaintenanceEventClientResource added in v0.2.0 

func (a *MaintenanceApiService) GetMaintenanceEventClientResource(ctx context.Context, localVarOptionals *MaintenanceApiGetMaintenanceEventClientResourceOpts) ([]MaintenanceEvent, *http.Response, error)

func (*MaintenanceApiService) GetMaintenanceEventIdClientResource added in v0.2.0 

func (a *MaintenanceApiService) GetMaintenanceEventIdClientResource(ctx context.Context, maintenanceEventId int32, localVarOptionals *MaintenanceApiGetMaintenanceEventIdClientResourceOpts) (MaintenanceEvent, *http.Response, error)

type MaintenanceEvent added in v0.2.0 

type MaintenanceEvent struct {
	// Maintenance Event End (UTC)
	End time.Time `json:"end,omitempty"`
	// Device IDs affected by event
	DeviceIds []int32 `json:"device_ids,omitempty"`
	// Maintenance Event Title
	Title string `json:"title,omitempty"`
	// Maintenance Event ID
	MaintenanceEventId int32 `json:"maintenanceEventId,omitempty"`
	// Maintenance Event Start (UTC)
	Start time.Time `json:"start,omitempty"`
	// Maintenance Event Description
	Description string `json:"description,omitempty"`
}

type Modification 

type Modification struct {
	Contents interface{} `json:"contents,omitempty"`
	Path     string      `json:"path,omitempty"`
	Reason   string      `json:"reason,omitempty"`
}

type MxRecordCreate 

type MxRecordCreate struct {
	Name       string `json:"name"`
	Ttl        int32  `json:"ttl"`
	Exchange   string `json:"exchange"`
	Preference int32  `json:"preference"`
}

type MxRecordReturn 

type MxRecordReturn struct {
	Exchange   string `json:"exchange"`
	Id         int32  `json:"id"`
	Ttl        int32  `json:"ttl"`
	Type_      string `json:"type"`
	Preference int32  `json:"preference"`
	Name       string `json:"name"`
	DomainId   int32  `json:"domainId"`
}

type MxRecordUpdate 

type MxRecordUpdate struct {
	Name       string `json:"name,omitempty"`
	Ttl        int32  `json:"ttl,omitempty"`
	Exchange   string `json:"exchange"`
	Preference int32  `json:"preference"`
}

type NetworkApiDeleteNullRoutesIdResourceOpts 

type NetworkApiDeleteNullRoutesIdResourceOpts struct {
	XFields optional.String
}

type NetworkApiGetDeviceNetworkPortResourceOpts 

type NetworkApiGetDeviceNetworkPortResourceOpts struct {
	XFields optional.String
}

type NetworkApiGetNetworkTaskClientResourceOpts 

type NetworkApiGetNetworkTaskClientResourceOpts struct {
	CreatedInLast optional.Int32
	ClientId      optional.Int32
	XFields       optional.String
}

type NetworkApiGetNetworkTaskIdResourceOpts 

type NetworkApiGetNetworkTaskIdResourceOpts struct {
	XFields optional.String
}

type NetworkApiGetNullRoutesIdResourceOpts 

type NetworkApiGetNullRoutesIdResourceOpts struct {
	XFields optional.String
}

type NetworkApiGetNullRoutesResourceOpts 

type NetworkApiGetNullRoutesResourceOpts struct {
	ClientId optional.Int32
	XFields  optional.String
}

type NetworkApiPostNullRoutesResourceOpts 

type NetworkApiPostNullRoutesResourceOpts struct {
	XFields optional.String
}

type NetworkApiService 

type NetworkApiService service

func (*NetworkApiService) DeleteNullRoutesIdResource 

func (a *NetworkApiService) DeleteNullRoutesIdResource(ctx context.Context, ipAddress string, localVarOptionals *NetworkApiDeleteNullRoutesIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*NetworkApiService) GetDeviceNetworkPortResource 

func (a *NetworkApiService) GetDeviceNetworkPortResource(ctx context.Context, localVarOptionals *NetworkApiGetDeviceNetworkPortResourceOpts) ([]DevicePort, *http.Response, error)

func (*NetworkApiService) GetNetworkTaskClientResource 

func (a *NetworkApiService) GetNetworkTaskClientResource(ctx context.Context, localVarOptionals *NetworkApiGetNetworkTaskClientResourceOpts) ([]NetworkTaskDump, *http.Response, error)

func (*NetworkApiService) GetNetworkTaskIdResource 

func (a *NetworkApiService) GetNetworkTaskIdResource(ctx context.Context, id string, localVarOptionals *NetworkApiGetNetworkTaskIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*NetworkApiService) GetNullRoutesIdResource 

func (a *NetworkApiService) GetNullRoutesIdResource(ctx context.Context, ipAddress string, localVarOptionals *NetworkApiGetNullRoutesIdResourceOpts) (NullRoute, *http.Response, error)

func (*NetworkApiService) GetNullRoutesResource 

func (a *NetworkApiService) GetNullRoutesResource(ctx context.Context, localVarOptionals *NetworkApiGetNullRoutesResourceOpts) ([]NullRoute, *http.Response, error)

func (*NetworkApiService) PostNullRoutesResource 

func (a *NetworkApiService) PostNullRoutesResource(ctx context.Context, payload NullRouteRequest, localVarOptionals *NetworkApiPostNullRoutesResourceOpts) (NetworkTaskDump, *http.Response, error)

type NetworkTaskDump 

type NetworkTaskDump struct {
	// Timestamp of task creation date.
	TaskCreated interface{} `json:"taskCreated,omitempty"`
	// Success|Pending|Failed. Null value also means Pending.
	Result string `json:"result,omitempty"`
	// Timestamp of most recent activity taken on the network task. This will update multiple times for multi-step tasks.
	TaskUpdated interface{} `json:"taskUpdated,omitempty"`
	// Unique ID of the network task.
	TaskId string `json:"taskId,omitempty"`
	// Unique ID of the client triggering the task.
	ClientId int32 `json:"clientId,omitempty"`
	// Unique ID of the target device.
	DeviceId int32 `json:"deviceId,omitempty"`
	// Key value arguments used to trigger the task.
	MetaData string `json:"metaData,omitempty"`
}

type NullRoute 

type NullRoute struct {
	// Filled if IP was nulled by an admin user
	AdminId int32 `json:"adminId,omitempty"`
	// IP address
	Ip string `json:"ip,omitempty"`
	// Timestamp the null route was created
	Created time.Time `json:"created,omitempty"`
	// Client ID who owns the IP
	ClientId int32 `json:"clientId,omitempty"`
	// Comment of the null route
	Comment string `json:"comment,omitempty"`
}

type NullRouteRequest 

type NullRouteRequest struct {
	// Public IPv4 Address
	Ip string `json:"ip"`
	// User comments about reason for null routing
	Comment string `json:"comment,omitempty"`
}

type OperatingSystem 

type OperatingSystem struct {
	SshKey      bool `json:"sshKey,omitempty"`
	PostInstall bool `json:"postInstall,omitempty"`
	CloudInit   bool `json:"cloudInit,omitempty"`
}

type OptionDump 

type OptionDump struct {
	// Used with `tags` to determine option compatibility. See product docs.
	Expressions []string `json:"expressions,omitempty"`
	// USD|other
	Currency string `json:"currency,omitempty"`
	// Unique ID of the option. Stays the same across products.
	Id int32 `json:"id,omitempty"`
	// Unique option name.
	Name string `json:"name"`
	// Monthly price of the option.
	MonthlyPrice float32 `json:"monthlyPrice,omitempty"`
	// Used with `expressions` to determine option compatibility. See product docs.
	Tags                    []string         `json:"tags,omitempty"`
	OperatingSystemFeatures *OperatingSystem `json:"operatingSystemFeatures,omitempty"`
}

type Options 

type Options struct {
}

type OrderApiGetOrderIdResourceOpts 

type OrderApiGetOrderIdResourceOpts struct {
	XFields optional.String
}

type OrderApiGetOrderInprogressResourceOpts 

type OrderApiGetOrderInprogressResourceOpts struct {
	XFields optional.String
}

type OrderApiGetOrderResourceOpts 

type OrderApiGetOrderResourceOpts struct {
	XFields optional.String
}

type OrderApiService 

type OrderApiService service

func (*OrderApiService) GetOrderIdResource 

func (a *OrderApiService) GetOrderIdResource(ctx context.Context, orderId int32, localVarOptionals *OrderApiGetOrderIdResourceOpts) (OrderDump, *http.Response, error)

func (*OrderApiService) GetOrderInprogressResource 

func (a *OrderApiService) GetOrderInprogressResource(ctx context.Context, localVarOptionals *OrderApiGetOrderInprogressResourceOpts) ([]OrderDump, *http.Response, error)

func (*OrderApiService) GetOrderResource 

func (a *OrderApiService) GetOrderResource(ctx context.Context, localVarOptionals *OrderApiGetOrderResourceOpts) ([]OrderDump, *http.Response, error)

type OrderDump 

type OrderDump struct {
	Status  string      `json:"status,omitempty"`
	OrderId int32       `json:"orderId,omitempty"`
	Info    interface{} `json:"info,omitempty"`
	Total   float32     `json:"total,omitempty"`
	Owner   string      `json:"owner,omitempty"`
}

type OrderGroup 

type OrderGroup struct {
	Name      string  `json:"name,omitempty"`
	SameRack  bool    `json:"same_rack,omitempty"`
	Id        int32   `json:"id,omitempty"`
	DeviceIds []int32 `json:"device_ids,omitempty"`
}

type OrderGroupCreate 

type OrderGroupCreate struct {
	Name     string `json:"name"`
	SameRack bool   `json:"same_rack,omitempty"`
}

type OrderGroupUpdate 

type OrderGroupUpdate struct {
	Name string `json:"name"`
}

type OrderGroupsApiGetOrderGroupIdResourceOpts 

type OrderGroupsApiGetOrderGroupIdResourceOpts struct {
	XFields optional.String
}

type OrderGroupsApiGetOrderGroupResourceOpts 

type OrderGroupsApiGetOrderGroupResourceOpts struct {
	XFields optional.String
}

type OrderGroupsApiPostOrderGroupResourceOpts 

type OrderGroupsApiPostOrderGroupResourceOpts struct {
	XFields optional.String
}

type OrderGroupsApiPutOrderGroupIdResourceOpts 

type OrderGroupsApiPutOrderGroupIdResourceOpts struct {
	XFields optional.String
}

type OrderGroupsApiService 

type OrderGroupsApiService service

func (*OrderGroupsApiService) DeleteOrderGroupIdResource 

func (a *OrderGroupsApiService) DeleteOrderGroupIdResource(ctx context.Context, orderGroupId int32) (*http.Response, error)

OrderGroupsApiService Delete the specified Order Group

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param orderGroupId Id of the order group to interact with

func (*OrderGroupsApiService) GetOrderGroupIdResource 

func (a *OrderGroupsApiService) GetOrderGroupIdResource(ctx context.Context, orderGroupId int32, localVarOptionals *OrderGroupsApiGetOrderGroupIdResourceOpts) (OrderGroup, *http.Response, error)

func (*OrderGroupsApiService) GetOrderGroupResource 

func (a *OrderGroupsApiService) GetOrderGroupResource(ctx context.Context, localVarOptionals *OrderGroupsApiGetOrderGroupResourceOpts) ([]OrderGroup, *http.Response, error)

func (*OrderGroupsApiService) PostOrderGroupResource 

func (a *OrderGroupsApiService) PostOrderGroupResource(ctx context.Context, payload OrderGroupCreate, localVarOptionals *OrderGroupsApiPostOrderGroupResourceOpts) (OrderGroup, *http.Response, error)

func (*OrderGroupsApiService) PutOrderGroupIdResource 

func (a *OrderGroupsApiService) PutOrderGroupIdResource(ctx context.Context, orderGroupId int32, payload OrderGroupUpdate, localVarOptionals *OrderGroupsApiPutOrderGroupIdResourceOpts) (OrderGroup, *http.Response, error)

type Password 

type Password struct {
	Password    string `json:"password"`
	NewPassword string `json:"newPassword"`
}

type PasswordRequest 

type PasswordRequest struct {
	Email string `json:"email"`
}

type PasswordResponse 

type PasswordResponse struct {
	Password string `json:"password"`
	Token    string `json:"token"`
}

type PaymentMethodsEnabled added in v0.2.0 

type PaymentMethodsEnabled struct {
	// Credit Card Enabled
	CcEnabled bool `json:"ccEnabled"`
	// ACH Enabled
	AchEnabled bool `json:"achEnabled"`
	// Client ID
	ClientId int32 `json:"clientId"`
}

type Permission 

type Permission struct {
	UserId      int32    `json:"userId"`
	Permissions []string `json:"permissions"`
}

type PermissionApiPostPermissionAssignContactResourceOpts 

type PermissionApiPostPermissionAssignContactResourceOpts struct {
	XFields optional.String
}

type PermissionApiService 

type PermissionApiService service

func (*PermissionApiService) GetPermissionAllResource 

func (a *PermissionApiService) GetPermissionAllResource(ctx context.Context) (*http.Response, error)

PermissionApiService Endpoint to get All Permissions

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*PermissionApiService) GetPermissionContactResource 

func (a *PermissionApiService) GetPermissionContactResource(ctx context.Context, contactId int32) (*http.Response, error)

PermissionApiService Endpoint to get Contact Permissions

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contactId

func (*PermissionApiService) GetPermissionUserResource 

func (a *PermissionApiService) GetPermissionUserResource(ctx context.Context) (*http.Response, error)

PermissionApiService Endpoint to get User Permissions

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*PermissionApiService) PostPermissionAssignContactResource 

func (a *PermissionApiService) PostPermissionAssignContactResource(ctx context.Context, payload Permission, localVarOptionals *PermissionApiPostPermissionAssignContactResourceOpts) ([]PermissionReturn, *http.Response, error)

type PermissionReturn 

type PermissionReturn struct {
	Name string `json:"name,omitempty"`
}

type PreviewEffectiveIgnition 

type PreviewEffectiveIgnition struct {
	Bonded           bool              `json:"bonded,omitempty"`
	Hostname         string            `json:"hostname,omitempty"`
	Password         string            `json:"password,omitempty"`
	PublicKeys       []string          `json:"publicKeys,omitempty"`
	PrimaryInterface *PrimaryInterface `json:"primaryInterface,omitempty"`
	Ignition         interface{}       `json:"ignition"`
}

type PreviewEffectiveIgnitionResponse 

type PreviewEffectiveIgnitionResponse struct {
	Modifications []Modification `json:"modifications,omitempty"`
	Original      interface{}    `json:"original,omitempty"`
	Result        interface{}    `json:"result,omitempty"`
}

type PrimaryInterface 

type PrimaryInterface struct {
	Ip         string   `json:"ip,omitempty"`
	Gateway    string   `json:"gateway,omitempty"`
	DnsServers []string `json:"dnsServers,omitempty"`
	Subnet     string   `json:"subnet,omitempty"`
}

type ProductApiGetProductOperatingSystemsResourceOpts 

type ProductApiGetProductOperatingSystemsResourceOpts struct {
	XFields optional.String
}

type ProductApiGetProductOptionResourceOpts 

type ProductApiGetProductOptionResourceOpts struct {
	GroupBy optional.String
}

type ProductApiGetProductsAndOptionsResourceOpts 

type ProductApiGetProductsAndOptionsResourceOpts struct {
	XFields optional.String
}

type ProductApiService 

type ProductApiService service

func (*ProductApiService) GetProductOperatingSystemsResource 

func (a *ProductApiService) GetProductOperatingSystemsResource(ctx context.Context, productId int32, localVarOptionals *ProductApiGetProductOperatingSystemsResourceOpts) ([]OptionDump, *http.Response, error)

func (*ProductApiService) GetProductOptionResource 

func (a *ProductApiService) GetProductOptionResource(ctx context.Context, productId int32, localVarOptionals *ProductApiGetProductOptionResourceOpts) (Options, *http.Response, error)

func (*ProductApiService) GetProductsAndOptionsResource 

func (a *ProductApiService) GetProductsAndOptionsResource(ctx context.Context, localVarOptionals *ProductApiGetProductsAndOptionsResourceOpts) ([]ProductOption, *http.Response, error)

type ProductOption 

type ProductOption struct {
	// Unique product id.
	ProductId int32 `json:"productId,omitempty"`
	// List of available options.
	Options interface{} `json:"options,omitempty"`
	// *DEPRECATED*
	Pricing interface{} `json:"pricing,omitempty"`
}

type ProfileApiGetBasicProfileResourceOpts 

type ProfileApiGetBasicProfileResourceOpts struct {
	ContactId optional.String
	XFields   optional.String
}

type ProfileApiGetProfileResourceOpts 

type ProfileApiGetProfileResourceOpts struct {
	ContactId optional.String
	XFields   optional.String
}

type ProfileApiPutProfileResourceOpts 

type ProfileApiPutProfileResourceOpts struct {
	ContactId optional.String
	XFields   optional.String
}

type ProfileApiService 

type ProfileApiService service

func (*ProfileApiService) GetBasicProfileResource 

func (a *ProfileApiService) GetBasicProfileResource(ctx context.Context, localVarOptionals *ProfileApiGetBasicProfileResourceOpts) (BasicProfileDump, *http.Response, error)

func (*ProfileApiService) GetProfileResource 

func (a *ProfileApiService) GetProfileResource(ctx context.Context, localVarOptionals *ProfileApiGetProfileResourceOpts) (ProfileDump, *http.Response, error)

func (*ProfileApiService) PutProfileResource 

func (a *ProfileApiService) PutProfileResource(ctx context.Context, payload ProfileUpdate, localVarOptionals *ProfileApiPutProfileResourceOpts) (ProfileDump, *http.Response, error)

type ProfileDump 

type ProfileDump struct {
	Login    string      `json:"login,omitempty"`
	First    string      `json:"first,omitempty"`
	Address  interface{} `json:"address,omitempty"`
	Phone    string      `json:"phone,omitempty"`
	Id       int32       `json:"id,omitempty"`
	State    interface{} `json:"state,omitempty"`
	Zip      interface{} `json:"zip,omitempty"`
	Fax      interface{} `json:"fax,omitempty"`
	Email    string      `json:"email,omitempty"`
	Company  interface{} `json:"company,omitempty"`
	Last     string      `json:"last,omitempty"`
	City     interface{} `json:"city,omitempty"`
	MetaData interface{} `json:"metaData,omitempty"`
	FullName interface{} `json:"fullName,omitempty"`
	Created  interface{} `json:"created,omitempty"`
	IsClient bool        `json:"isClient,omitempty"`
	Country  interface{} `json:"country,omitempty"`
}

type ProfileUpdate 

type ProfileUpdate struct {
	Address                 string `json:"address,omitempty"`
	First                   string `json:"first,omitempty"`
	DirectToZendesk         string `json:"directToZendesk,omitempty"`
	State                   string `json:"state,omitempty"`
	Zip                     string `json:"zip,omitempty"`
	Email                   string `json:"email,omitempty"`
	Company                 string `json:"company,omitempty"`
	Last                    string `json:"last,omitempty"`
	Password                string `json:"password,omitempty"`
	City                    string `json:"city,omitempty"`
	RequireOauthLogin       string `json:"requireOauthLogin,omitempty"`
	FullName                string `json:"fullName,omitempty"`
	RequirePayPalOauthLogin string `json:"requirePayPalOauthLogin,omitempty"`
	DisableInvoiceEmails    bool   `json:"disableInvoiceEmails,omitempty"`
	Phone                   string `json:"phone,omitempty"`
	Country                 string `json:"country,omitempty"`
}

type PtrRecordReturn 

type PtrRecordReturn struct {
	Address  string `json:"address,omitempty"`
	Id       int32  `json:"id,omitempty"`
	Ttl      int32  `json:"ttl,omitempty"`
	Type_    string `json:"type,omitempty"`
	Name     string `json:"name,omitempty"`
	DomainId int32  `json:"domainId,omitempty"`
	Disabled bool   `json:"disabled,omitempty"`
}

type PtrRecordUpdate 

type PtrRecordUpdate struct {
	Name string `json:"name"`
	Ttl  int32  `json:"ttl,omitempty"`
}

type PublicApiHideTokenDump 

type PublicApiHideTokenDump struct {
	TimeCreated time.Time         `json:"timeCreated,omitempty"`
	TimeUpdated time.Time         `json:"timeUpdated,omitempty"`
	IpAddresses *PublicApiTokenIp `json:"ipAddresses,omitempty"`
	Name        string            `json:"name,omitempty"`
	// Token expiration datetime in UTC format.
	TimeExpiration time.Time `json:"timeExpiration"`
	Token          string    `json:"token"`
	ApiTokenId     string    `json:"apiTokenId,omitempty"`
}

type PublicApiToken 

type PublicApiToken struct {
	Name string `json:"name,omitempty"`
	// Token expiration datetime in Unix time format.
	TimeExpiration time.Time         `json:"timeExpiration,omitempty"`
	IpAddresses    *PublicApiTokenIp `json:"ipAddresses,omitempty"`
}

type PublicApiTokenIp 

type PublicApiTokenIp struct {
	Name string   `json:"name,omitempty"`
	Ips  []string `json:"ips"`
}

type PublicApiTokenLoad 

type PublicApiTokenLoad struct {
	Name       string `json:"name,omitempty"`
	ApiTokenId string `json:"apiTokenId,omitempty"`
}

type PublicApiTokenResponsePostDump 

type PublicApiTokenResponsePostDump struct {
	TimeCreated time.Time         `json:"timeCreated,omitempty"`
	TimeUpdated time.Time         `json:"timeUpdated,omitempty"`
	IpAddresses *PublicApiTokenIp `json:"ipAddresses,omitempty"`
	Name        string            `json:"name,omitempty"`
	// Token expiration datetime in UTC format.
	TimeExpiration time.Time `json:"timeExpiration"`
	Token          string    `json:"token"`
	ApiTokenId     string    `json:"apiTokenId,omitempty"`
}

type Service 

type Service struct {
	ServiceId                int32           `json:"serviceId,omitempty"`
	Created                  int32           `json:"created,omitempty"`
	BilledPrice              float32         `json:"billedPrice,omitempty"`
	BilledPricePerPeriod     float32         `json:"billedPricePerPeriod,omitempty"`
	ServiceCost              float32         `json:"serviceCost,omitempty"`
	LastRenew                int32           `json:"lastRenew,omitempty"`
	RenewDate                int32           `json:"renewDate,omitempty"`
	Quantity                 float32         `json:"quantity,omitempty"`
	OrderId                  int32           `json:"orderId,omitempty"`
	Status                   string          `json:"status,omitempty"`
	Period                   string          `json:"period,omitempty"`
	Discount                 float32         `json:"discount,omitempty"`
	DiscountType             string          `json:"discountType,omitempty"`
	DiscountedCost           float32         `json:"discountedCost,omitempty"`
	ServiceDiscount          float32         `json:"serviceDiscount,omitempty"`
	ServiceDiscountPerPeriod float32         `json:"serviceDiscountPerPeriod,omitempty"`
	IpAddress                string          `json:"ipAddress,omitempty"`
	CancelAfter              int32           `json:"cancelAfter,omitempty"`
	StartDate                int32           `json:"startDate,omitempty"`
	EndDate                  int32           `json:"endDate,omitempty"`
	ServiceOptions           []ServiceOption `json:"serviceOptions,omitempty"`
	Usage                    interface{}     `json:"usage,omitempty"`
	ServiceDevices           []interface{}   `json:"serviceDevices,omitempty"`
	ChildServices            []interface{}   `json:"childServices,omitempty"`
	ProductId                int32           `json:"productId,omitempty"`
	ProductName              string          `json:"productName,omitempty"`
	Reseller                 string          `json:"reseller,omitempty"`
	ServiceType              string          `json:"serviceType,omitempty"`
	ContractTerm             int32           `json:"contractTerm,omitempty"`
	BillingInfoId            int32           `json:"billingInfoId,omitempty"`
	AutoBill                 bool            `json:"autoBill,omitempty"`
	ColocationCharge         float32         `json:"colocationCharge,omitempty"`
	ResellerBmaasCharge      float32         `json:"resellerBmaasCharge,omitempty"`
	FacilityName             string          `json:"facilityName,omitempty"`
	// The service type code. The list of service types can be accessed on https://core.hivelocity.net/api/v2/service/types .
	TypeCode         string                   `json:"typeCode,omitempty"`
	BandwidthBilling *ServiceBandwidthBilling `json:"bandwidthBilling,omitempty"`
	Acquisition      string                   `json:"acquisition,omitempty"`
}

type ServiceApiGetServiceIdResourceOpts 

type ServiceApiGetServiceIdResourceOpts struct {
	IncludeZeroPriceOptions optional.Bool
	XFields                 optional.String
}

type ServiceApiGetServiceManageableResourceOpts 

type ServiceApiGetServiceManageableResourceOpts struct {
	XFields optional.String
}

type ServiceApiGetServiceManagedReqResourceOpts 

type ServiceApiGetServiceManagedReqResourceOpts struct {
	XFields optional.String
}

type ServiceApiGetServiceResourceOpts 

type ServiceApiGetServiceResourceOpts struct {
	TypeCode optional.String
	OrderId  optional.Int32
	XFields  optional.String
}

type ServiceApiGetServiceTypeResourceOpts 

type ServiceApiGetServiceTypeResourceOpts struct {
	XFields optional.String
}

type ServiceApiPostServiceIdValidateCouponResourceOpts 

type ServiceApiPostServiceIdValidateCouponResourceOpts struct {
	XFields optional.String
}

type ServiceApiService 

type ServiceApiService service

func (*ServiceApiService) GetServiceIdResource 

func (a *ServiceApiService) GetServiceIdResource(ctx context.Context, serviceId int32, localVarOptionals *ServiceApiGetServiceIdResourceOpts) (Service, *http.Response, error)

func (*ServiceApiService) GetServiceManageableResource 

func (a *ServiceApiService) GetServiceManageableResource(ctx context.Context, serviceId int32, localVarOptionals *ServiceApiGetServiceManageableResourceOpts) (ServiceManageable, *http.Response, error)

func (*ServiceApiService) GetServiceManagedReqResource 

func (a *ServiceApiService) GetServiceManagedReqResource(ctx context.Context, localVarOptionals *ServiceApiGetServiceManagedReqResourceOpts) (ServiceManagedReq, *http.Response, error)

func (*ServiceApiService) GetServiceResource 

func (a *ServiceApiService) GetServiceResource(ctx context.Context, status string, localVarOptionals *ServiceApiGetServiceResourceOpts) ([]FastServiceDump, *http.Response, error)

func (*ServiceApiService) GetServiceTypeResource 

func (a *ServiceApiService) GetServiceTypeResource(ctx context.Context, localVarOptionals *ServiceApiGetServiceTypeResourceOpts) ([]ServiceType, *http.Response, error)

func (*ServiceApiService) PostServiceIdApplyCouponResource 

func (a *ServiceApiService) PostServiceIdApplyCouponResource(ctx context.Context, serviceId int32, payload CartCoupon) (*http.Response, error)

ServiceApiService Apply the coupon code for a service

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param serviceId
  • @param payload

func (*ServiceApiService) PostServiceIdValidateCouponResource 

func (a *ServiceApiService) PostServiceIdValidateCouponResource(ctx context.Context, serviceId int32, payload CartCoupon, localVarOptionals *ServiceApiPostServiceIdValidateCouponResourceOpts) (ValidateCartCouponDump, *http.Response, error)

type ServiceBandwidthBilling 

type ServiceBandwidthBilling struct {
	BillingMethod        string `json:"billingMethod,omitempty"`
	IncludedTransferUnit string `json:"includedTransferUnit,omitempty"`
	Notification         string `json:"notification,omitempty"`
	OverageUnit          string `json:"overageUnit,omitempty"`
}

type ServiceManageable 

type ServiceManageable struct {
	Eligible      bool   `json:"eligible,omitempty"`
	OsDetected    string `json:"os_detected,omitempty"`
	PanelDetected string `json:"panel_detected,omitempty"`
}

type ServiceManagedReq 

type ServiceManagedReq struct {
	EligibleOs    interface{} `json:"eligible_os,omitempty"`
	EligiblePanel interface{} `json:"eligible_panel,omitempty"`
}

type ServiceOption 

type ServiceOption struct {
	// Upgrade ID of hardware option
	UpgradeId int32 `json:"upgradeId,omitempty"`
	// Upgrade name of hardware option
	UpgradeName string `json:"upgradeName,omitempty"`
	// Option name of hardware option
	OptionName string `json:"optionName,omitempty"`
	OptionId   int32  `json:"optionId,omitempty"`
}

type ServiceOptionData 

type ServiceOptionData struct {
	ServiceOptionId int32  `json:"serviceOptionId,omitempty"`
	Name            string `json:"name,omitempty"`
	OptionId        int32  `json:"optionId,omitempty"`
	UpgradeName     string `json:"upgradeName,omitempty"`
	GroupName       string `json:"groupName,omitempty"`
	InvoiceHide     string `json:"invoiceHide,omitempty"`
}

type ServiceType 

type ServiceType struct {
	// The name of the service type
	Name string `json:"name,omitempty"`
	// The unique Code of the service type
	Code string `json:"code,omitempty"`
}

type Services 

type Services struct {
}

type SshKey 

type SshKey struct {
	Name string `json:"name"`
	// Public key content (RSA or Ed25519 supported)
	PublicKey string `json:"publicKey"`
}

type SshKeyApiGetSshKeyIdResourceOpts 

type SshKeyApiGetSshKeyIdResourceOpts struct {
	XFields optional.String
}

type SshKeyApiGetSshKeyResourceOpts 

type SshKeyApiGetSshKeyResourceOpts struct {
	XFields optional.String
}

type SshKeyApiPostSshKeyResourceOpts 

type SshKeyApiPostSshKeyResourceOpts struct {
	XFields optional.String
}

type SshKeyApiPutSshKeyIdResourceOpts 

type SshKeyApiPutSshKeyIdResourceOpts struct {
	XFields optional.String
}

type SshKeyApiService 

type SshKeyApiService service

func (*SshKeyApiService) DeleteSshKeyIdResource 

func (a *SshKeyApiService) DeleteSshKeyIdResource(ctx context.Context, sshKeyId int32) (*http.Response, error)

SshKeyApiService Removes public ssh key

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param sshKeyId

func (*SshKeyApiService) GetSshKeyIdResource 

func (a *SshKeyApiService) GetSshKeyIdResource(ctx context.Context, sshKeyId int32, localVarOptionals *SshKeyApiGetSshKeyIdResourceOpts) (SshKeyResponse, *http.Response, error)

func (*SshKeyApiService) GetSshKeyResource 

func (a *SshKeyApiService) GetSshKeyResource(ctx context.Context, localVarOptionals *SshKeyApiGetSshKeyResourceOpts) ([]SshKeyResponse, *http.Response, error)

func (*SshKeyApiService) PostSshKeyResource 

func (a *SshKeyApiService) PostSshKeyResource(ctx context.Context, payload SshKey, localVarOptionals *SshKeyApiPostSshKeyResourceOpts) (SshKeyResponse, *http.Response, error)

func (*SshKeyApiService) PutSshKeyIdResource 

func (a *SshKeyApiService) PutSshKeyIdResource(ctx context.Context, sshKeyId int32, payload SshKeyUpdate, localVarOptionals *SshKeyApiPutSshKeyIdResourceOpts) (SshKeyResponse, *http.Response, error)

type SshKeyResponse 

type SshKeyResponse struct {
	Name      string `json:"name,omitempty"`
	SshKeyId  int32  `json:"sshKeyId,omitempty"`
	PublicKey string `json:"publicKey,omitempty"`
}

type SshKeyUpdate 

type SshKeyUpdate struct {
	Name string `json:"name,omitempty"`
	// Public key content (RSA or Ed25519 supported)
	PublicKey string `json:"publicKey,omitempty"`
}

type Stock 

type Stock struct {
	// true|false. If product is SPS
	IsSps bool `json:"is_sps,omitempty"`
	// Price per hour.
	ProductHourlyPrice float32 `json:"product_hourly_price,omitempty"`
	// Human readable CPU core and thread info in HTML format.
	ProductCpuCores string `json:"product_cpu_cores,omitempty"`
	// Additional biennial fee for this `product_id` in this `data_center`.
	BiennialLocationPremium float32 `json:"biennial_location_premium,omitempty"`
	// Price per 3 year period (36 months).
	ProductTriennialPrice float32 `json:"product_triennial_price,omitempty"`
	// Additional triennial fee for this `product_id` in this `data_center`.
	TriennialLocationPremium float32 `json:"triennial_location_premium,omitempty"`
	// true|false. If SPS product is VPS type
	IsVps bool `json:"is_vps,omitempty"`
	// Additional annual fee for this `product_id` in this `data_center`.
	AnnuallyLocationPremium float32 `json:"annually_location_premium,omitempty"`
	// Additional semi-annual fee for this `product_id` in this `data_center`.
	SemiAnnuallyLocationPremium float32 `json:"semi_annually_location_premium,omitempty"`
	// Human readable GPU specs.
	ProductGpu string `json:"product_gpu,omitempty"`
	// true|false. Use with `product_original_price`.
	ProductOnSale bool `json:"product_on_sale,omitempty"`
	// Retail price of product. Use with `product_on_sale`.
	ProductOriginalPrice float32 `json:"product_original_price,omitempty"`
	// Price per half year (6 months).
	ProductSemiAnnuallyPrice float32 `json:"product_semi_annually_price,omitempty"`
	// Human readable networking specs in the format: Free Outbound Transfer / NIC Size
	ProductBandwidth string `json:"product_bandwidth,omitempty"`
	// Price per 2 year period (24 months).
	ProductBiennialPrice float32 `json:"product_biennial_price,omitempty"`
	// Price per year (12 months).
	ProductAnnuallyPrice float32 `json:"product_annually_price,omitempty"`
	// Price per month.
	ProductMonthlyPrice float32 `json:"product_monthly_price,omitempty"`
	// The unique name of this product.
	ProductName string `json:"product_name,omitempty"`
	// available|limited|unavailable. Limited denotes minimal stock.
	Stock string `json:"stock,omitempty"`
	// Orders for the periods in the array will fail. Possible values: hourly|monthly|quarterly|semi-annually|biennial|triennial
	ProductDisabledBillingPeriods []string `json:"product_disabled_billing_periods,omitempty"`
	// Price per quarter (3 months).
	ProductQuarterlyPrice float32 `json:"product_quarterly_price,omitempty"`
	// Human readable CPU specs.
	ProductCpu string `json:"product_cpu,omitempty"`
	// Additional hourly fee for this `product_id` in this `data_center`.
	HourlyLocationPremium float32 `json:"hourly_location_premium,omitempty"`
	// Location option ID for datacenter
	LocationOptionId int32 `json:"location_option_id,omitempty"`
	// The unique ID of this product.
	ProductId int32 `json:"product_id,omitempty"`
	// JSON CPU info for cores, threads, sockets, and vCPUs.
	ProcessorInfo interface{} `json:"processor_info,omitempty"`
	// *DEPRECATED*.
	ProductDisplayPrice float32 `json:"product_display_price,omitempty"`
	// Human readable drive specs. Can include multiple drives.
	ProductDrive string `json:"product_drive,omitempty"`
	// Human readable memory specs.
	ProductMemory string `json:"product_memory,omitempty"`
	// true|false if core site.
	Core bool `json:"core,omitempty"`
	// A facility code. For example `NYC1`.
	DataCenter string `json:"data_center,omitempty"`
	// Additional quarterly fee for this `product_id` in this `data_center`.
	QuarterlyLocationPremium float32 `json:"quarterly_location_premium,omitempty"`
	// Additional monthly fee for this `product_id` in this `data_center`.
	MonthlyLocationPremium float32 `json:"monthly_location_premium,omitempty"`
	// true|false if edge site.
	Edge bool `json:"edge,omitempty"`
}

type Ticket 

type Ticket struct {
	Status         string       `json:"status,omitempty"`
	Subject        string       `json:"subject,omitempty"`
	Queue          string       `json:"queue,omitempty"`
	Updated        float32      `json:"updated,omitempty"`
	Opened         float32      `json:"opened,omitempty"`
	ServiceId      float32      `json:"serviceId,omitempty"`
	Client         *Client      `json:"client,omitempty"`
	Priority       string       `json:"priority,omitempty"`
	Id             float32      `json:"id,omitempty"`
	Posts          float32      `json:"posts,omitempty"`
	Contact        *ContactDump `json:"contact,omitempty"`
	Body           string       `json:"body,omitempty"`
	NewReply       bool         `json:"newReply,omitempty"`
	MetaData       interface{}  `json:"metaData,omitempty"`
	Replies        []TicketPost `json:"replies,omitempty"`
	ClientId       float32      `json:"clientId,omitempty"`
	ContactId      float32      `json:"contactId,omitempty"`
	Duration       float32      `json:"duration,omitempty"`
	InternalTicket float32      `json:"internalTicket,omitempty"`
}

type TicketApiGetTicketIdResourceOpts 

type TicketApiGetTicketIdResourceOpts struct {
	XFields optional.String
}

type TicketApiGetTicketReplyResourceOpts 

type TicketApiGetTicketReplyResourceOpts struct {
	XFields optional.String
}

type TicketApiGetTicketResourceOpts 

type TicketApiGetTicketResourceOpts struct {
	XFields optional.String
}

type TicketApiGetTicketSearchResourceOpts 

type TicketApiGetTicketSearchResourceOpts struct {
	PerPage optional.Int32
	Page    optional.Int32
	Q       optional.String
	XFields optional.String
}

type TicketApiPostTicketReplyResourceOpts 

type TicketApiPostTicketReplyResourceOpts struct {
	XFields optional.String
}

type TicketApiPostTicketResourceOpts 

type TicketApiPostTicketResourceOpts struct {
	XFields optional.String
}

type TicketApiPutTicketIdResourceOpts 

type TicketApiPutTicketIdResourceOpts struct {
	XFields optional.String
}

type TicketApiService 

type TicketApiService service

func (*TicketApiService) GetTicketIdResource 

func (a *TicketApiService) GetTicketIdResource(ctx context.Context, ticketId int32, localVarOptionals *TicketApiGetTicketIdResourceOpts) (Ticket, *http.Response, error)

func (*TicketApiService) GetTicketReplyResource 

func (a *TicketApiService) GetTicketReplyResource(ctx context.Context, ticketId int32, localVarOptionals *TicketApiGetTicketReplyResourceOpts) ([]TicketPost, *http.Response, error)

func (*TicketApiService) GetTicketResource 

func (a *TicketApiService) GetTicketResource(ctx context.Context, localVarOptionals *TicketApiGetTicketResourceOpts) ([]Ticket, *http.Response, error)

func (*TicketApiService) GetTicketSearchResource 

func (a *TicketApiService) GetTicketSearchResource(ctx context.Context, localVarOptionals *TicketApiGetTicketSearchResourceOpts) (TicketSeachResult, *http.Response, error)

func (*TicketApiService) PostTicketReplyResource 

func (a *TicketApiService) PostTicketReplyResource(ctx context.Context, ticketId int32, payload TicketCreateReply, localVarOptionals *TicketApiPostTicketReplyResourceOpts) (TicketPost, *http.Response, error)

func (*TicketApiService) PostTicketResource 

func (a *TicketApiService) PostTicketResource(ctx context.Context, payload TicketCreate, localVarOptionals *TicketApiPostTicketResourceOpts) (Ticket, *http.Response, error)

func (*TicketApiService) PutTicketIdResource 

func (a *TicketApiService) PutTicketIdResource(ctx context.Context, ticketId int32, payload TicketPut, localVarOptionals *TicketApiPutTicketIdResourceOpts) (Ticket, *http.Response, error)

type TicketAttach 

type TicketAttach struct {
	Name string  `json:"name,omitempty"`
	Id   float32 `json:"id,omitempty"`
}

type TicketCreate 

type TicketCreate struct {
	Source     float32 `json:"source,omitempty"`
	Priority   float32 `json:"priority,omitempty"`
	Body       string  `json:"body,omitempty"`
	Status     string  `json:"status,omitempty"`
	Subject    string  `json:"subject"`
	Assignment float32 `json:"assignment,omitempty"`
	Queue      string  `json:"queue"`
}

type TicketCreateReply 

type TicketCreateReply struct {
	Body        string        `json:"body"`
	ReplyTo     string        `json:"replyTo,omitempty"`
	Date        float32       `json:"date,omitempty"`
	Attachments []interface{} `json:"attachments,omitempty"`
	Hidden      float32       `json:"hidden,omitempty"`
	Subject     string        `json:"subject,omitempty"`
	Type_       float32       `json:"type,omitempty"`
	Headers     string        `json:"headers,omitempty"`
	Cc          string        `json:"cc,omitempty"`
	Recipient   string        `json:"recipient,omitempty"`
	Encrypted   string        `json:"encrypted,omitempty"`
	ContactId   float32       `json:"contactId,omitempty"`
}

type TicketPost 

type TicketPost struct {
	AdminId                float32        `json:"adminId,omitempty"`
	FromAdmin              bool           `json:"fromAdmin,omitempty"`
	Body                   string         `json:"body,omitempty"`
	From                   interface{}    `json:"from,omitempty"`
	Id                     float32        `json:"id,omitempty"`
	Attachments            float32        `json:"attachments,omitempty"`
	Hidden                 float32        `json:"hidden,omitempty"`
	Subject                string         `json:"subject,omitempty"`
	UbersmithAttachedFiles []TicketAttach `json:"ubersmith_attached_files,omitempty"`
	TicketId               float32        `json:"ticketId,omitempty"`
	ClientId               float32        `json:"clientId,omitempty"`
	Date                   float32        `json:"date,omitempty"`
	ContactId              float32        `json:"contactId,omitempty"`
}

type TicketPut 

type TicketPut struct {
	Status string `json:"status,omitempty"`
}

type TicketSeachResult 

type TicketSeachResult struct {
	Pages    int32       `json:"pages,omitempty"`
	NextPage int32       `json:"nextPage,omitempty"`
	Items    *TicketPost `json:"items,omitempty"`
	Page     int32       `json:"page,omitempty"`
	PrevPage int32       `json:"prevPage,omitempty"`
	HasNext  bool        `json:"hasNext,omitempty"`
	Total    int32       `json:"total,omitempty"`
	PerPage  int32       `json:"perPage,omitempty"`
	HasPrev  bool        `json:"hasPrev,omitempty"`
}

type TokenApiGetTokenResourceOpts 

type TokenApiGetTokenResourceOpts struct {
	XFields optional.String
}

type TokenApiPostTokenResourceOpts 

type TokenApiPostTokenResourceOpts struct {
	XFields optional.String
}

type TokenApiPutTokenResourceOpts 

type TokenApiPutTokenResourceOpts struct {
	XFields optional.String
}

type TokenApiService 

type TokenApiService service

func (*TokenApiService) DeleteTokenResource 

func (a *TokenApiService) DeleteTokenResource(ctx context.Context, payload DeleteApiTokenLoad) (*http.Response, error)

TokenApiService Deletes the Public API Token with apiTokenId

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param payload

func (*TokenApiService) GetTokenResource 

func (a *TokenApiService) GetTokenResource(ctx context.Context, localVarOptionals *TokenApiGetTokenResourceOpts) ([]PublicApiHideTokenDump, *http.Response, error)

func (*TokenApiService) PostTokenResource 

func (a *TokenApiService) PostTokenResource(ctx context.Context, payload PublicApiToken, localVarOptionals *TokenApiPostTokenResourceOpts) (PublicApiTokenResponsePostDump, *http.Response, error)

func (*TokenApiService) PutTokenResource 

func (a *TokenApiService) PutTokenResource(ctx context.Context, payload PublicApiTokenLoad, localVarOptionals *TokenApiPutTokenResourceOpts) (PublicApiHideTokenDump, *http.Response, error)

type TotalActiveCredit 

type TotalActiveCredit struct {
	// Whether credits are automatically being applied to new orders
	AutoApply bool `json:"autoApply,omitempty"`
	// If a client has an incomplete order that is using credit, the \"total active\" will remain at 0 until the order is completed.
	HasCreditPendingOrder bool `json:"hasCreditPendingOrder,omitempty"`
	// The total active amount of credit available on the client account
	TotalActive float32 `json:"totalActive,omitempty"`
}

type UpdateDevicesIpmiThresholds 

type UpdateDevicesIpmiThresholds struct {
	// List of unique device IDs.
	DeviceIds []int32 `json:"device_ids"`
	// Alert thresholds for IPMI sensor values.
	Thresholds interface{} `json:"thresholds"`
}

type UpdateIgnition 

type UpdateIgnition struct {
	Contents string `json:"contents"`
}

type VLANApiGetVlanIdResourceOpts 

type VLANApiGetVlanIdResourceOpts struct {
	XFields optional.String
}

type VLANApiGetVlanResourceOpts 

type VLANApiGetVlanResourceOpts struct {
	XFields optional.String
}

type VLANApiPostVlanIdClearResourceOpts 

type VLANApiPostVlanIdClearResourceOpts struct {
	XFields optional.String
}

type VLANApiPostVlanResourceOpts 

type VLANApiPostVlanResourceOpts struct {
	XFields optional.String
}

type VLANApiPutVlanIdResourceOpts 

type VLANApiPutVlanIdResourceOpts struct {
	XFields optional.String
}

type VLANApiService 

type VLANApiService service

func (*VLANApiService) DeleteVlanIdResource 

func (a *VLANApiService) DeleteVlanIdResource(ctx context.Context, vlanId int32) (*http.Response, error)

VLANApiService Delete VLAN

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param vlanId Id of the VLAN to interact with

func (*VLANApiService) GetVlanIdResource 

func (a *VLANApiService) GetVlanIdResource(ctx context.Context, vlanId int32, localVarOptionals *VLANApiGetVlanIdResourceOpts) (Vlan, *http.Response, error)

func (*VLANApiService) GetVlanResource 

func (a *VLANApiService) GetVlanResource(ctx context.Context, localVarOptionals *VLANApiGetVlanResourceOpts) ([]Vlan, *http.Response, error)

func (*VLANApiService) PostVlanIdClearResource 

func (a *VLANApiService) PostVlanIdClearResource(ctx context.Context, vlanId int32, localVarOptionals *VLANApiPostVlanIdClearResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VLANApiService) PostVlanResource 

func (a *VLANApiService) PostVlanResource(ctx context.Context, payload VlanCreate, localVarOptionals *VLANApiPostVlanResourceOpts) (Vlan, *http.Response, error)

func (*VLANApiService) PutVlanIdResource 

func (a *VLANApiService) PutVlanIdResource(ctx context.Context, vlanId int32, payload VlanUpdate, localVarOptionals *VLANApiPutVlanIdResourceOpts) (NetworkTaskDump, *http.Response, error)

type VPSApiDeleteVpsIdNetworkRemoveResourceOpts added in v0.2.0 

type VPSApiDeleteVpsIdNetworkRemoveResourceOpts struct {
	XFields optional.String
}

type VPSApiDeleteVpsNetworkIdResourceOpts added in v0.2.0 

type VPSApiDeleteVpsNetworkIdResourceOpts struct {
	XFields optional.String
}

type VPSApiDeleteVpsSecondaryIpRemoveResourceOpts added in v0.2.0 

type VPSApiDeleteVpsSecondaryIpRemoveResourceOpts struct {
	XFields optional.String
}

type VPSApiDeleteVpsSnapshotIdResourceOpts 

type VPSApiDeleteVpsSnapshotIdResourceOpts struct {
	ClientId     optional.Int32
	FacilityCode optional.String
	XFields      optional.String
}

type VPSApiDeleteVpsSnapshotScheduleIdResourceOpts 

type VPSApiDeleteVpsSnapshotScheduleIdResourceOpts struct {
	ClientId     optional.Int32
	FacilityCode optional.String
	XFields      optional.String
}

type VPSApiDeleteVpsVolumeIdResourceOpts 

type VPSApiDeleteVpsVolumeIdResourceOpts struct {
	XFields optional.String
}

type VPSApiDeleteVpsisoIdResourceOpts 

type VPSApiDeleteVpsisoIdResourceOpts struct {
	FacilityCode optional.String
	ClientId     optional.Int32
	XFields      optional.String
}

type VPSApiGetVpsAvailableNewVolumesResourceOpts 

type VPSApiGetVpsAvailableNewVolumesResourceOpts struct {
	XFields optional.String
}

type VPSApiGetVpsAvailableUpgradeSizesResourceOpts 

type VPSApiGetVpsAvailableUpgradeSizesResourceOpts struct {
	XFields optional.String
}

type VPSApiGetVpsIdEventsResourceOpts 

type VPSApiGetVpsIdEventsResourceOpts struct {
	XFields optional.String
}

type VPSApiGetVpsIdResourceOpts 

type VPSApiGetVpsIdResourceOpts struct {
	XFields optional.String
}

type VPSApiGetVpsMetricsResourceOpts 

type VPSApiGetVpsMetricsResourceOpts struct {
	StartTime   optional.Int32
	EndTime     optional.Int32
	ImageWidth  optional.Int32
	ImageHeight optional.Int32
	XFields     optional.String
}

type VPSApiGetVpsNetworkIdResourceOpts added in v0.2.0 

type VPSApiGetVpsNetworkIdResourceOpts struct {
	ClientId     optional.Int32
	FacilityCode optional.String
	XFields      optional.String
}

type VPSApiGetVpsNetworkResourceOpts added in v0.2.0 

type VPSApiGetVpsNetworkResourceOpts struct {
	ClientId     optional.Int32
	FacilityCode optional.String
	XFields      optional.String
}

type VPSApiGetVpsResourceOpts added in v0.2.0 

type VPSApiGetVpsResourceOpts struct {
	StorageId    optional.String
	ClientId     optional.Int32
	HostId       optional.String
	FacilityCode optional.String
	NetworkId    optional.String
	XFields      optional.String
}

type VPSApiGetVpsSecondaryIpAddResourceOpts added in v0.2.0 

type VPSApiGetVpsSecondaryIpAddResourceOpts struct {
	XFields optional.String
}

type VPSApiGetVpsSnapshotIdResourceOpts 

type VPSApiGetVpsSnapshotIdResourceOpts struct {
	ClientId     optional.Int32
	FacilityCode optional.String
	XFields      optional.String
}

type VPSApiGetVpsSnapshotResourceOpts 

type VPSApiGetVpsSnapshotResourceOpts struct {
	DeviceId     optional.Int32
	FacilityCode optional.String
	ClientId     optional.Int32
	XFields      optional.String
}

type VPSApiGetVpsSnapshotScheduleIdResourceOpts 

type VPSApiGetVpsSnapshotScheduleIdResourceOpts struct {
	ClientId     optional.Int32
	FacilityCode optional.String
	XFields      optional.String
}

type VPSApiGetVpsSnapshotScheduleResourceOpts 

type VPSApiGetVpsSnapshotScheduleResourceOpts struct {
	DeviceId     optional.Int32
	FacilityCode optional.String
	ClientId     optional.Int32
	XFields      optional.String
}

type VPSApiGetVpsVolumeIdResourceOpts 

type VPSApiGetVpsVolumeIdResourceOpts struct {
	XFields optional.String
}

type VPSApiGetVpsVolumeResourceOpts 

type VPSApiGetVpsVolumeResourceOpts struct {
	DeviceId     optional.Int32
	FacilityCode optional.String
	ClientId     optional.Int32
	XFields      optional.String
}

type VPSApiGetVpsisoIdResourceOpts 

type VPSApiGetVpsisoIdResourceOpts struct {
	FacilityCode optional.String
	ClientId     optional.Int32
	XFields      optional.String
}

type VPSApiGetVpsisoResourceOpts 

type VPSApiGetVpsisoResourceOpts struct {
	FacilityCode optional.String
	ClientId     optional.Int32
	XFields      optional.String
}

type VPSApiPostVpsAttachIsoResourceOpts 

type VPSApiPostVpsAttachIsoResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsAttachVolumeResourceOpts added in v0.2.0 

type VPSApiPostVpsAttachVolumeResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsConsoleAccessResourceOpts 

type VPSApiPostVpsConsoleAccessResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsDetachIsoResourceOpts 

type VPSApiPostVpsDetachIsoResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsDetachVolumeResourceOpts added in v0.2.0 

type VPSApiPostVpsDetachVolumeResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsIdNetworkAddResourceOpts added in v0.2.0 

type VPSApiPostVpsIdNetworkAddResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsNetworkResourceOpts added in v0.2.0 

type VPSApiPostVpsNetworkResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsSecondaryIpAddResourceOpts added in v0.2.0 

type VPSApiPostVpsSecondaryIpAddResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsSnapshotIdResourceOpts 

type VPSApiPostVpsSnapshotIdResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsSnapshotResourceOpts 

type VPSApiPostVpsSnapshotResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsSnapshotScheduleResourceOpts 

type VPSApiPostVpsSnapshotScheduleResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsVolumeResourceOpts 

type VPSApiPostVpsVolumeResourceOpts struct {
	XFields optional.String
}

type VPSApiPostVpsisoResourceOpts 

type VPSApiPostVpsisoResourceOpts struct {
	XFields optional.String
}

type VPSApiPutVpsIdResourceOpts 

type VPSApiPutVpsIdResourceOpts struct {
	XFields optional.String
}

type VPSApiPutVpsNetworkIdResourceOpts added in v0.2.0 

type VPSApiPutVpsNetworkIdResourceOpts struct {
	XFields optional.String
}

type VPSApiPutVpsResetPasswordResourceOpts added in v0.2.0 

type VPSApiPutVpsResetPasswordResourceOpts struct {
	XFields optional.String
}

type VPSApiPutVpsVolumeIdResourceOpts 

type VPSApiPutVpsVolumeIdResourceOpts struct {
	XFields optional.String
}

type VPSApiService 

type VPSApiService service

func (*VPSApiService) DeleteVpsIdNetworkRemoveResource added in v0.2.0 

func (a *VPSApiService) DeleteVpsIdNetworkRemoveResource(ctx context.Context, deviceId int32, networkId string, localVarOptionals *VPSApiDeleteVpsIdNetworkRemoveResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) DeleteVpsNetworkIdResource added in v0.2.0 

func (a *VPSApiService) DeleteVpsNetworkIdResource(ctx context.Context, networkId string, localVarOptionals *VPSApiDeleteVpsNetworkIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) DeleteVpsSecondaryIpRemoveResource added in v0.2.0 

func (a *VPSApiService) DeleteVpsSecondaryIpRemoveResource(ctx context.Context, deviceId int32, ipAssignmentId int32, localVarOptionals *VPSApiDeleteVpsSecondaryIpRemoveResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) DeleteVpsSnapshotIdResource 

func (a *VPSApiService) DeleteVpsSnapshotIdResource(ctx context.Context, snapshotId string, localVarOptionals *VPSApiDeleteVpsSnapshotIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) DeleteVpsSnapshotScheduleIdResource 

func (a *VPSApiService) DeleteVpsSnapshotScheduleIdResource(ctx context.Context, snapshotScheduleId string, localVarOptionals *VPSApiDeleteVpsSnapshotScheduleIdResourceOpts) (*http.Response, error)

func (*VPSApiService) DeleteVpsVolumeIdResource 

func (a *VPSApiService) DeleteVpsVolumeIdResource(ctx context.Context, volumeId string, payload VpsVolumeDelete, localVarOptionals *VPSApiDeleteVpsVolumeIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) DeleteVpsisoIdResource 

func (a *VPSApiService) DeleteVpsisoIdResource(ctx context.Context, isoId string, localVarOptionals *VPSApiDeleteVpsisoIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) GetVpsAvailableNewVolumesResource 

func (a *VPSApiService) GetVpsAvailableNewVolumesResource(ctx context.Context, localVarOptionals *VPSApiGetVpsAvailableNewVolumesResourceOpts) (VpsAvailableNewVolumeSizes, *http.Response, error)

func (*VPSApiService) GetVpsAvailableUpgradeSizesResource 

func (a *VPSApiService) GetVpsAvailableUpgradeSizesResource(ctx context.Context, volumeId string, localVarOptionals *VPSApiGetVpsAvailableUpgradeSizesResourceOpts) (VpsAvailableUpgradeSizes, *http.Response, error)

func (*VPSApiService) GetVpsIdEventsResource 

func (a *VPSApiService) GetVpsIdEventsResource(ctx context.Context, deviceId int32, localVarOptionals *VPSApiGetVpsIdEventsResourceOpts) ([]VpsEvent, *http.Response, error)

func (*VPSApiService) GetVpsIdResource 

func (a *VPSApiService) GetVpsIdResource(ctx context.Context, deviceId int32, localVarOptionals *VPSApiGetVpsIdResourceOpts) (Vps, *http.Response, error)

func (*VPSApiService) GetVpsMetricsResource 

func (a *VPSApiService) GetVpsMetricsResource(ctx context.Context, deviceId int32, metricType string, localVarOptionals *VPSApiGetVpsMetricsResourceOpts) (VpsMetricsResponse, *http.Response, error)

func (*VPSApiService) GetVpsNetworkIdResource added in v0.2.0 

func (a *VPSApiService) GetVpsNetworkIdResource(ctx context.Context, networkId string, localVarOptionals *VPSApiGetVpsNetworkIdResourceOpts) (VpsNetwork, *http.Response, error)

func (*VPSApiService) GetVpsNetworkResource added in v0.2.0 

func (a *VPSApiService) GetVpsNetworkResource(ctx context.Context, localVarOptionals *VPSApiGetVpsNetworkResourceOpts) ([]VpsNetwork, *http.Response, error)

func (*VPSApiService) GetVpsResource added in v0.2.0 

func (a *VPSApiService) GetVpsResource(ctx context.Context, localVarOptionals *VPSApiGetVpsResourceOpts) ([]Vps, *http.Response, error)

func (*VPSApiService) GetVpsSecondaryIpAddResource added in v0.2.0 

func (a *VPSApiService) GetVpsSecondaryIpAddResource(ctx context.Context, deviceId int32, localVarOptionals *VPSApiGetVpsSecondaryIpAddResourceOpts) ([]IpAssignment, *http.Response, error)

func (*VPSApiService) GetVpsSelfMetadataResource 

func (a *VPSApiService) GetVpsSelfMetadataResource(ctx context.Context) (*http.Response, error)

VPSApiService

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*VPSApiService) GetVpsSnapshotIdResource 

func (a *VPSApiService) GetVpsSnapshotIdResource(ctx context.Context, snapshotId string, localVarOptionals *VPSApiGetVpsSnapshotIdResourceOpts) (VpsSnapshot, *http.Response, error)

func (*VPSApiService) GetVpsSnapshotResource 

func (a *VPSApiService) GetVpsSnapshotResource(ctx context.Context, localVarOptionals *VPSApiGetVpsSnapshotResourceOpts) ([]VpsSnapshot, *http.Response, error)

func (*VPSApiService) GetVpsSnapshotScheduleIdResource 

func (a *VPSApiService) GetVpsSnapshotScheduleIdResource(ctx context.Context, snapshotScheduleId string, localVarOptionals *VPSApiGetVpsSnapshotScheduleIdResourceOpts) (VpsSnapshotSchedule, *http.Response, error)

func (*VPSApiService) GetVpsSnapshotScheduleResource 

func (a *VPSApiService) GetVpsSnapshotScheduleResource(ctx context.Context, localVarOptionals *VPSApiGetVpsSnapshotScheduleResourceOpts) ([]VpsSnapshotSchedule, *http.Response, error)

func (*VPSApiService) GetVpsVolumeIdResource 

func (a *VPSApiService) GetVpsVolumeIdResource(ctx context.Context, volumeId string, localVarOptionals *VPSApiGetVpsVolumeIdResourceOpts) (VpsVolume, *http.Response, error)

func (*VPSApiService) GetVpsVolumeResource 

func (a *VPSApiService) GetVpsVolumeResource(ctx context.Context, localVarOptionals *VPSApiGetVpsVolumeResourceOpts) ([]VpsVolume, *http.Response, error)

func (*VPSApiService) GetVpsisoIdResource 

func (a *VPSApiService) GetVpsisoIdResource(ctx context.Context, isoId string, localVarOptionals *VPSApiGetVpsisoIdResourceOpts) (Vpsiso, *http.Response, error)

func (*VPSApiService) GetVpsisoResource 

func (a *VPSApiService) GetVpsisoResource(ctx context.Context, localVarOptionals *VPSApiGetVpsisoResourceOpts) ([]Vpsiso, *http.Response, error)

func (*VPSApiService) PostVpsAttachIsoResource 

func (a *VPSApiService) PostVpsAttachIsoResource(ctx context.Context, deviceId int32, payload VpsisoAttach, localVarOptionals *VPSApiPostVpsAttachIsoResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsAttachVolumeResource added in v0.2.0 

func (a *VPSApiService) PostVpsAttachVolumeResource(ctx context.Context, volumeId string, deviceId int32, localVarOptionals *VPSApiPostVpsAttachVolumeResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsConsoleAccessResource 

func (a *VPSApiService) PostVpsConsoleAccessResource(ctx context.Context, deviceId int32, localVarOptionals *VPSApiPostVpsConsoleAccessResourceOpts) (VpsConsoleAccess, *http.Response, error)

func (*VPSApiService) PostVpsDetachIsoResource 

func (a *VPSApiService) PostVpsDetachIsoResource(ctx context.Context, deviceId int32, localVarOptionals *VPSApiPostVpsDetachIsoResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsDetachVolumeResource added in v0.2.0 

func (a *VPSApiService) PostVpsDetachVolumeResource(ctx context.Context, volumeId string, deviceId int32, localVarOptionals *VPSApiPostVpsDetachVolumeResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsIdNetworkAddResource added in v0.2.0 

func (a *VPSApiService) PostVpsIdNetworkAddResource(ctx context.Context, deviceId int32, payload VpsInstanceNetworkAdd, localVarOptionals *VPSApiPostVpsIdNetworkAddResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsNetworkResource added in v0.2.0 

func (a *VPSApiService) PostVpsNetworkResource(ctx context.Context, payload VpsNetworkCreate, localVarOptionals *VPSApiPostVpsNetworkResourceOpts) (VpsNetwork, *http.Response, error)

func (*VPSApiService) PostVpsResetPasswordResource added in v0.2.0 

func (a *VPSApiService) PostVpsResetPasswordResource(ctx context.Context, deviceId int32) (*http.Response, error)

VPSApiService Request token to reset root password for VPS

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param deviceId Device ID of VPS instance

func (*VPSApiService) PostVpsSecondaryIpAddResource added in v0.2.0 

func (a *VPSApiService) PostVpsSecondaryIpAddResource(ctx context.Context, deviceId int32, localVarOptionals *VPSApiPostVpsSecondaryIpAddResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsSnapshotIdResource 

func (a *VPSApiService) PostVpsSnapshotIdResource(ctx context.Context, snapshotId string, payload VpsSnapshotRestore, localVarOptionals *VPSApiPostVpsSnapshotIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsSnapshotResource 

func (a *VPSApiService) PostVpsSnapshotResource(ctx context.Context, payload VpsSnapshotCreate, localVarOptionals *VPSApiPostVpsSnapshotResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsSnapshotScheduleResource 

func (a *VPSApiService) PostVpsSnapshotScheduleResource(ctx context.Context, payload VpsSnapshotScheduleCreate, localVarOptionals *VPSApiPostVpsSnapshotScheduleResourceOpts) (VpsSnapshotSchedule, *http.Response, error)

func (*VPSApiService) PostVpsVolumeResource 

func (a *VPSApiService) PostVpsVolumeResource(ctx context.Context, payload VpsVolumeCreate, localVarOptionals *VPSApiPostVpsVolumeResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PostVpsisoResource 

func (a *VPSApiService) PostVpsisoResource(ctx context.Context, payload VpsisoCreate, localVarOptionals *VPSApiPostVpsisoResourceOpts) (Vpsiso, *http.Response, error)

func (*VPSApiService) PutVpsIdResource 

func (a *VPSApiService) PutVpsIdResource(ctx context.Context, deviceId int32, payload VpsUpdate, localVarOptionals *VPSApiPutVpsIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PutVpsNetworkIdResource added in v0.2.0 

func (a *VPSApiService) PutVpsNetworkIdResource(ctx context.Context, networkId string, payload VpsNetworkUpdate, localVarOptionals *VPSApiPutVpsNetworkIdResourceOpts) (NetworkTaskDump, *http.Response, error)

func (*VPSApiService) PutVpsResetPasswordResource added in v0.2.0 

func (a *VPSApiService) PutVpsResetPasswordResource(ctx context.Context, deviceId int32, payload VpsResetRootPassword, localVarOptionals *VPSApiPutVpsResetPasswordResourceOpts) (*http.Response, error)

func (*VPSApiService) PutVpsVolumeIdResource 

func (a *VPSApiService) PutVpsVolumeIdResource(ctx context.Context, volumeId string, payload VpsVolumeUpdate, localVarOptionals *VPSApiPutVpsVolumeIdResourceOpts) (NetworkTaskDump, *http.Response, error)

type ValidateCartCouponDump 

type ValidateCartCouponDump struct {
	// The coupon code to validate.
	CouponCode string                        `json:"couponCode"`
	Coupon     *ValidateCartCoupondumpCoupon `json:"coupon,omitempty"`
	// The unique client account ID.
	ClientId int32 `json:"clientId,omitempty"`
	// Error message if coupon is invalid.
	Error_ string `json:"error,omitempty"`
	// Whether the coupon is valid.
	IsValid bool `json:"isValid,omitempty"`
}

type ValidateCartCoupondumpCoupon 

type ValidateCartCoupondumpCoupon struct {
}

The coupon object.

type Vlan 

type Vlan struct {
	// Unique ID of the VLAN.
	VlanId int32 `json:"vlanId,omitempty"`
	// Unique IDs of IP Assignments.
	IpIds []int32 `json:"ipIds,omitempty"`
	// If true, VLAN can be automated via API. If false, contact support to enable automation.
	Automated bool `json:"automated,omitempty"`
	// If `public`, this VLAN can have IPs assigned to become reachable from the internet. If `private`, this VLAN can not have IPs assigned and will never be reachabled from the internet. All VLANs are subject to traffic billing and overages, with the exception of private VLAN traffic on unbonded Devices.
	Type_ string `json:"type,omitempty"`
	// The VLAN Tag id from the switch. Use this value when configuring your OS interfaces to use the VLAN.
	VlanTag int32 `json:"vlanTag,omitempty"`
	// If true, VLAN is configured in Q-in-Q Mode. Automation is not currently supported on Q-in-Q VLANs.
	QInQ bool `json:"qInQ,omitempty"`
	// Unique IDs of ports or bonds.
	PortIds []int32 `json:"portIds,omitempty"`
	// For example: `NYC1`.
	FacilityCode string `json:"facilityCode,omitempty"`
}

type VlanCreate 

type VlanCreate struct {
	// The Facility where the VLAN will be created, for example: `NYC1`. Only Devices from the same Facility are allowed in the VLANs.
	FacilityCode string `json:"facilityCode"`
	// Choose `public` if you want to be able to assign IPs to the VLAN, making it reachable from the internet. Choose `private` if the VLAN should never be reachable from the internet. All VLANs are subject to traffic billing and overages, with the exception of private VLAN traffic on unbonded Devices.
	Type_ string `json:"type"`
}

type VlanUpdate 

type VlanUpdate struct {
	// Unique IDs of IP Assignments.
	IpIds []int32 `json:"ipIds,omitempty"`
	// Unique IDs of ports or bonds.
	PortIds []int32 `json:"portIds"`
}

type Vps 

type Vps struct {
	// Number of vCPUs
	Vcpu int32 `json:"vcpu,omitempty"`
	// List of SSH Key IDs
	SshKeyIds []int32 `json:"sshKeyIds,omitempty"`
	// Cloud-init script
	CloudInit string `json:"cloudInit,omitempty"`
	// VPS Instance Status. Example: `Running`
	Status string `json:"status,omitempty"`
	// Memory in MB
	Memory int32 `json:"memory,omitempty"`
	// VPS Instance root password
	Password string `json:"password,omitempty"`
	// The unique ID of the VPS ISO.
	IsoId string        `json:"isoId,omitempty"`
	Nics  []interface{} `json:"nics,omitempty"`
	// Device ID
	DeviceId int32 `json:"deviceId,omitempty"`
	// Facility Code. Example: `LAX3`
	FacilityCode string `json:"facilityCode,omitempty"`
	// Template used for the install
	TemplateId string `json:"templateId,omitempty"`
}

type VpsAvailableNewVolumeSizes 

type VpsAvailableNewVolumeSizes struct {
	// List volume products that can be created
	VolumeProducts []VpsVolumeProduct `json:"volumeProducts,omitempty"`
}

type VpsAvailableUpgradeSizes 

type VpsAvailableUpgradeSizes struct {
	// List volume products to upgrade to for volume (in GiB)
	VolumeProducts []VpsVolumeProduct `json:"volumeProducts,omitempty"`
}

type VpsConsoleAccess 

type VpsConsoleAccess struct {
	// URL for console access
	Url string `json:"url,omitempty"`
}

type VpsEvent 

type VpsEvent struct {
	// The state of the event at the time of recording ie. Scheduled, Started or Completed.
	State string `json:"state,omitempty"`
	// The level of the event ie. INFO, ERROR or WARNING.
	Level string `json:"level,omitempty"`
	// The type of event being logged for the VPS instance.
	Type_ string `json:"type,omitempty"`
	// The created date/time of the VPS instance event.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// The unique ID corresponding to the event recorded.
	EventId string `json:"eventId,omitempty"`
}

type VpsInstanceNetworkAdd added in v0.2.0 

type VpsInstanceNetworkAdd struct {
	// The unique ID of the network to add to the VPS instance.
	NetworkId string `json:"networkId,omitempty"`
}

type VpsMetricsResponse 

type VpsMetricsResponse struct {
	// Base64 encoded Image Data.
	ImageData string `json:"imageData,omitempty"`
	// The Metric Type requested.
	MetricType string `json:"metricType,omitempty"`
	// Actual Start Time for Chart Data.
	StartTime int32 `json:"startTime,omitempty"`
	// Actual End Time for Chart Data.
	EndTime int32 `json:"endTime,omitempty"`
}

type VpsNetwork added in v0.2.0 

type VpsNetwork struct {
	// The VLAN ID of the VPS Network. This will be returned for VLAN enabled networks.
	VlanId int32 `json:"vlanId,omitempty"`
	// The name of the VPS Network.
	Name string `json:"name,omitempty"`
	// The VLAN tag of the VPS Network. This will be returned for VLAN enabled networks.
	VlanTag int32 `json:"vlanTag,omitempty"`
	// The facility code associated with the VPS Network. For example: `TPA1`.
	FacilityCode string `json:"facilityCode,omitempty"`
	// The unique ID of the VPS Network.
	NetworkId string `json:"networkId,omitempty"`
}

type VpsNetworkCreate added in v0.2.0 

type VpsNetworkCreate struct {
	// The name of the VPS Network.
	Name string `json:"name,omitempty"`
	// The VLAN ID of the VPS Network. This will make the network bridgeble to dedicated servers.
	VlanId int32 `json:"vlanId,omitempty"`
	// The facility code where the VPS Network should be created. For example: `TPA1`.
	FacilityCode string `json:"facilityCode"`
	// The unique client account ID.
	ClientId int32 `json:"clientId,omitempty"`
}

type VpsNetworkInterface 

type VpsNetworkInterface struct {
	// The unique ID of the VPS instance NIC.
	NicId string `json:"nicId,omitempty"`
	// The IPv6 address assigned to the VPS instance NIC.
	Ipv6Address string `json:"ipv6Address,omitempty"`
	// The VLAN ID of the VPS Network. This will be returned for VLAN enabled networks.
	VlanId int32 `json:"vlanId,omitempty"`
	// The IPv6 CIDR assigned to the VPS instance NIC.
	Ipv6Cidr string `json:"ipv6Cidr,omitempty"`
	// The netmask assigned to the VPS instance NIC.
	Netmask string `json:"netmask,omitempty"`
	// The name of the VPS instance NIC.
	NicName string `json:"nicName,omitempty"`
	// The name of the VPS Network.
	NetworkName string `json:"networkName,omitempty"`
	// The IPv6 gateway assigned to the VPS instance NIC.
	Ipv6Gateway string `json:"ipv6Gateway,omitempty"`
	// The IP address assigned to the VPS instance NIC.
	IpAddress string `json:"ipAddress,omitempty"`
	// The VLAN tag of the VPS Network. This will be returned for VLAN enabled networks.
	VlanTag int32 `json:"vlanTag,omitempty"`
	// The gateway assigned to the VPS instance NIC.
	Gateway string `json:"gateway,omitempty"`
	// The MAC address of the VPS instance NIC.
	MacAddress string `json:"macAddress,omitempty"`
	// The unique ID of the VPS Network.
	NetworkId string `json:"networkId,omitempty"`
}

type VpsNetworkUpdate added in v0.2.0 

type VpsNetworkUpdate struct {
	// The name of the VPS Network.
	Name string `json:"name"`
}

type VpsResetRootPassword added in v0.2.0 

type VpsResetRootPassword struct {
	// The token used to reset the root password for the VPS instance.
	Token string `json:"token"`
}

type VpsSnapshot 

type VpsSnapshot struct {
	// The unique VPS instance volume ID the snapshot is taken of.
	VolumeId string `json:"volumeId,omitempty"`
	// The unique ID associated with the snapshot.
	SnapshotId string `json:"snapshotId,omitempty"`
	// The state of the snapshot ie. Scheduled, Started or Completed.
	State string `json:"state,omitempty"`
	// Snapshot size in bytes
	Size int32 `json:"size,omitempty"`
	// The name of the VPS instance snapshot.
	Name string `json:"name,omitempty"`
	// Snapshot interval options: HOURLY, DAILY, WEEKLY, MONTHLY.
	SnapshotType string `json:"snapshotType,omitempty"`
	// The created date/tie of the VPS instance snapshot.
	CreatedAt time.Time `json:"createdAt,omitempty"`
}

type VpsSnapshotCreate 

type VpsSnapshotCreate struct {
	// The name of the VPS instance snapshot.
	Name string `json:"name"`
	// The unique client account ID.
	ClientId int32 `json:"clientId,omitempty"`
	// The unique VPS instance volume ID the snapshot is taken of.
	VolumeId string `json:"volumeId"`
	// The facility code associated with the VPS instance. For example:TPA1.
	FacilityCode string `json:"facilityCode"`
}

type VpsSnapshotRestore 

type VpsSnapshotRestore struct {
	// The unique client acount ID.
	ClientId int32 `json:"clientId,omitempty"`
	// The facility code associated with the VPS instance. For example:TPA1.
	FacilityCode string `json:"facilityCode"`
}

type VpsSnapshotSchedule 

type VpsSnapshotSchedule struct {
	// The unique ID associated with the snapshot schedule.
	SnapshotScheduleId string `json:"snapshotScheduleId,omitempty"`
	// The minute of the hour to run the snapshot process (0-59).
	Minute int32 `json:"minute,omitempty"`
	// The unique ID of the VPS instance volume to take a snapshot of.
	VolumeId string `json:"volumeId,omitempty"`
	// The day of the month to run the snapshot process (1-28).
	Day int32 `json:"day,omitempty"`
	// The day of the week to run the snapshot process (1-7 with 1 being Monday).
	Weekday int32 `json:"weekday,omitempty"`
	// Snapshot interval options: HOURLY, DAILY, WEEKLY, MONTHLY.
	IntervalType string `json:"intervalType,omitempty"`
	// The maximum number of snapshots to take within the interval period.
	MaxSnapshots int32 `json:"maxSnapshots,omitempty"`
	// The hour of the day to run the snapshot process (0-23).
	Hour int32 `json:"hour,omitempty"`
	// The timezone to use for the snapshot schedule in IANA format. Example: America/New_York.
	Timezone string `json:"timezone,omitempty"`
}

type VpsSnapshotScheduleCreate 

type VpsSnapshotScheduleCreate struct {
	// The minute of the hour to run the snapshot process (0-59).
	Minute int32 `json:"minute"`
	// The unique ID of the VPS instance volume to take a snapshot of.
	VolumeId string `json:"volumeId"`
	// The day of the month to run th snapshot process (1-28). This is required for Monthly.
	Day int32 `json:"day,omitempty"`
	// The day of the week to run the snapshot process (1-7 with 1 being Monday). This is required for Weekly.
	Weekday int32 `json:"weekday,omitempty"`
	// Options: `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`
	IntervalType string `json:"intervalType"`
	// The maximum number of snapshots to retain at a time for this schedule.
	MaxSnapshots int32 `json:"maxSnapshots"`
	// The unique client account ID.
	ClientId int32 `json:"clientId,omitempty"`
	// The hour of the day to run the snapshot process (0-23).
	Hour int32 `json:"hour"`
	// The facility code associated witht he VPS instance. For example:TPA1.
	FacilityCode string `json:"facilityCode"`
	// Timezone in IANA format. Example: `America/New_York`
	Timezone string `json:"timezone"`
}

type VpsUpdate 

type VpsUpdate struct {
	// ID of VPS product to scale to
	ProductId int32 `json:"productId,omitempty"`
	// List of SSH Key IDs
	SshKeyIds []int32 `json:"sshKeyIds,omitempty"`
	// Cloud-init script
	CloudInit string `json:"cloudInit,omitempty"`
}

type VpsVolume 

type VpsVolume struct {
	// The unique VPS instance volume ID.
	VolumeId string `json:"volumeId,omitempty"`
	// Disk type. Options are `ROOT` for root volumes and `DATADISK` for additional disks.
	Type_ string `json:"type,omitempty"`
	// Disk size in bytes
	Size int32 `json:"size,omitempty"`
	// The created date/time of the VPS instance volume.
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// Device ID the disk is attached to
	DeviceId int32 `json:"deviceId,omitempty"`
	// The facility code associated with the VPS Volume. For example: `TPA1`.
	FacilityCode string `json:"facilityCode,omitempty"`
}

type VpsVolumeCreate 

type VpsVolumeCreate struct {
	// Device ID to attach the disk to
	DeviceId int32 `json:"deviceId"`
	// Disk size in GiB
	Size int32 `json:"size"`
}

type VpsVolumeDelete 

type VpsVolumeDelete struct {
	// Device ID the disk is attached to
	DeviceId int32 `json:"deviceId,omitempty"`
}

type VpsVolumeProduct 

type VpsVolumeProduct struct {
	// Monthly cost of volume size
	MonthlyPrice float32 `json:"monthlyPrice,omitempty"`
	// Size of available volume size in GiB
	Size int32 `json:"size,omitempty"`
}

type VpsVolumeUpdate 

type VpsVolumeUpdate struct {
	// Device ID the disk is attached to
	DeviceId int32 `json:"deviceId,omitempty"`
	// Disk size in GiB
	Size int32 `json:"size"`
}

type Vpsiso 

type Vpsiso struct {
	// Determines whether the VPS instance ISO is bootable or not.
	Bootable bool `json:"bootable,omitempty"`
	// The status of the VPS instance ISO.
	Status string `json:"status,omitempty"`
	// These are the device IDs with the ISO attached.
	DeviceIds []int32 `json:"deviceIds,omitempty"`
	// The size of the VPS instance ISO.
	Size int32 `json:"size,omitempty"`
	// The name of the VPS instance ISO.
	Name string `json:"name,omitempty"`
	// The ready state of the VPS instance ISO.
	Ready bool `json:"ready,omitempty"`
	// The unique ID of the VPS instance ISO.
	IsoId string `json:"isoId,omitempty"`
	// The URL to be directed to when downloading the VPS instance ISO.
	Url string `json:"url,omitempty"`
	// The description of the VPS instance ISO.
	Description string `json:"description,omitempty"`
	// The facility code associated with the ISO instance. For example:TPA1.
	FacilityCode string `json:"facilityCode,omitempty"`
}

type VpsisoAttach 

type VpsisoAttach struct {
	// The unique ID of the VPS instance ISO.
	IsoId string `json:"isoId"`
}

type VpsisoCreate 

type VpsisoCreate struct {
	// Determines whether the VPS instance ISO is bootable or not.
	Bootable bool `json:"bootable"`
	// The name of the VPS instance ISO.
	Name string `json:"name"`
	// The unique client account ID.
	ClientId int32 `json:"clientId,omitempty"`
	// The URL to be directed to when downloading the VPS instance ISO.
	Url string `json:"url"`
	// The description of the VPS instance ISO.
	Description string `json:"description"`
	// The facility code associated wth the VPS instance.  For example:TPA1.
	FacilityCode string `json:"facilityCode"`
}

type Webhook 

type Webhook struct {
	WebhookId int32       `json:"webhookId"`
	Name      string      `json:"name"`
	Event     string      `json:"event"`
	Url       string      `json:"url"`
	Headers   interface{} `json:"headers,omitempty"`
}

type WebhookApiGetWebhookEventResourceOpts 

type WebhookApiGetWebhookEventResourceOpts struct {
	XFields optional.String
}

type WebhookApiGetWebhookIdResourceOpts 

type WebhookApiGetWebhookIdResourceOpts struct {
	XFields optional.String
}

type WebhookApiGetWebhookResourceOpts 

type WebhookApiGetWebhookResourceOpts struct {
	XFields optional.String
}

type WebhookApiPostEventScriptActionTriggerResourceOpts 

type WebhookApiPostEventScriptActionTriggerResourceOpts struct {
	WebhookName optional.String
}

type WebhookApiPostWebhookResourceOpts 

type WebhookApiPostWebhookResourceOpts struct {
	XFields optional.String
}

type WebhookApiPutWebhookIdResourceOpts 

type WebhookApiPutWebhookIdResourceOpts struct {
	XFields optional.String
}

type WebhookApiService 

type WebhookApiService service

func (*WebhookApiService) DeleteWebhookIdResource 

func (a *WebhookApiService) DeleteWebhookIdResource(ctx context.Context, webhookId int32) (*http.Response, error)

WebhookApiService Deletes a single webhook

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param webhookId ID of Webhook to View / Update

func (*WebhookApiService) GetWebhookEventResource 

func (a *WebhookApiService) GetWebhookEventResource(ctx context.Context, localVarOptionals *WebhookApiGetWebhookEventResourceOpts) ([]WebhookEvent, *http.Response, error)

func (*WebhookApiService) GetWebhookIdResource 

func (a *WebhookApiService) GetWebhookIdResource(ctx context.Context, webhookId int32, localVarOptionals *WebhookApiGetWebhookIdResourceOpts) (Webhook, *http.Response, error)

func (*WebhookApiService) GetWebhookResource 

func (a *WebhookApiService) GetWebhookResource(ctx context.Context, localVarOptionals *WebhookApiGetWebhookResourceOpts) ([]Webhook, *http.Response, error)

func (*WebhookApiService) PostEventScriptActionTriggerResource 

func (a *WebhookApiService) PostEventScriptActionTriggerResource(ctx context.Context, localVarOptionals *WebhookApiPostEventScriptActionTriggerResourceOpts) (*http.Response, error)

func (*WebhookApiService) PostWebhookResource 

func (a *WebhookApiService) PostWebhookResource(ctx context.Context, payload WebhookCreate, localVarOptionals *WebhookApiPostWebhookResourceOpts) (Webhook, *http.Response, error)

func (*WebhookApiService) PutWebhookIdResource 

func (a *WebhookApiService) PutWebhookIdResource(ctx context.Context, webhookId int32, payload WebhookUpdate, localVarOptionals *WebhookApiPutWebhookIdResourceOpts) (Webhook, *http.Response, error)

type WebhookCreate 

type WebhookCreate struct {
	Name    string      `json:"name,omitempty"`
	Event   string      `json:"event"`
	Url     string      `json:"url"`
	Headers interface{} `json:"headers,omitempty"`
}

type WebhookEvent 

type WebhookEvent struct {
	Name string `json:"name"`
	Desc string `json:"desc"`
}

type WebhookUpdate 

type WebhookUpdate struct {
	Name    string      `json:"name,omitempty"`
	Event   string      `json:"event,omitempty"`
	Url     string      `json:"url,omitempty"`
	Headers interface{} `json:"headers,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.