Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

common/

directory

Go to main page

Versions in this module

v0

v0.5.3

Jan 21, 2026

v0.5.2

Dec 4, 2025

v0.5.1

Apr 16, 2025

v0.5.0

Apr 16, 2025

v0.4.0

Sep 23, 2024

v0.3.0

Aug 19, 2024

v0.1.7

Jun 6, 2023

v0.1.6

Jun 6, 2023

v0.1.5

May 30, 2023

Changes in this version

+ func NewGetCustomerDetailRequest(server string, params *GetCustomerDetailParams) (*http.Request, error)

+ func NewGetCustomerRequest(server string, params *GetCustomerParams) (*http.Request, error)

+ func NewGetOutagesRequest(server string, params *GetOutagesParams) (*http.Request, error)

+ func NewGetStatusRequest(server string, params *GetStatusParams) (*http.Request, error)

+ type Client struct

+ Client HttpRequestDoer

+ RequestEditors []RequestEditorFn

+ Server string

+ func NewClient(server string, opts ...ClientOption) (*Client, error)

+ func (c *Client) GetCustomer(ctx context.Context, params *GetCustomerParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetCustomerDetail(ctx context.Context, params *GetCustomerDetailParams, ...) (*http.Response, error)

+ func (c *Client) GetOutages(ctx context.Context, params *GetOutagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ func (c *Client) GetStatus(ctx context.Context, params *GetStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ type ClientInterface interface

+ GetCustomer func(ctx context.Context, params *GetCustomerParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetCustomerDetail func(ctx context.Context, params *GetCustomerDetailParams, ...) (*http.Response, error)

+ GetOutages func(ctx context.Context, params *GetOutagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ GetStatus func(ctx context.Context, params *GetStatusParams, reqEditors ...RequestEditorFn) (*http.Response, error)

+ type ClientOption func(*Client) error

+ func WithBaseURL(baseURL string) ClientOption

+ func WithHTTPClient(doer HttpRequestDoer) ClientOption

+ func WithRequestEditorFn(fn RequestEditorFn) ClientOption

+ type ClientWithResponses struct

+ func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

+ func (c *ClientWithResponses) GetCustomerDetailWithResponse(ctx context.Context, params *GetCustomerDetailParams, ...) (*GetCustomerDetailResponse, error)

+ func (c *ClientWithResponses) GetCustomerWithResponse(ctx context.Context, params *GetCustomerParams, reqEditors ...RequestEditorFn) (*GetCustomerResponse, error)

+ func (c *ClientWithResponses) GetOutagesWithResponse(ctx context.Context, params *GetOutagesParams, reqEditors ...RequestEditorFn) (*GetOutagesResponse, error)

+ func (c *ClientWithResponses) GetStatusWithResponse(ctx context.Context, params *GetStatusParams, reqEditors ...RequestEditorFn) (*GetStatusResponse, error)

+ type ClientWithResponsesInterface interface

+ GetCustomerDetailWithResponse func(ctx context.Context, params *GetCustomerDetailParams, ...) (*GetCustomerDetailResponse, error)

+ GetCustomerWithResponse func(ctx context.Context, params *GetCustomerParams, reqEditors ...RequestEditorFn) (*GetCustomerResponse, error)

+ GetOutagesWithResponse func(ctx context.Context, params *GetOutagesParams, reqEditors ...RequestEditorFn) (*GetOutagesResponse, error)

+ GetStatusWithResponse func(ctx context.Context, params *GetStatusParams, reqEditors ...RequestEditorFn) (*GetStatusResponse, error)

+ type CommonEmailAddress struct

+ Address string

+ IsPreferred *bool

+ Purpose CommonEmailAddressPurpose

+ type CommonEmailAddressPurpose string

+ const CommonEmailAddressPurposeHOME

+ const CommonEmailAddressPurposeOTHER

+ const CommonEmailAddressPurposeUNSPECIFIED

+ const CommonEmailAddressPurposeWORK

+ type CommonOrganisation struct

+ Abn *string

+ Acn *string

+ AgentFirstName *string

+ AgentLastName string

+ AgentRole string

+ BusinessName string

+ EstablishmentDate *string

+ IndustryCode *string

+ IndustryCodeVersion *CommonOrganisationIndustryCodeVersion

+ IsACNCRegistered *bool

+ LastUpdateTime *string

+ LegalName *string

+ OrganisationType CommonOrganisationOrganisationType

+ RegisteredCountry *string

+ ShortName *string

+ type CommonOrganisationDetailV2 struct

+ Abn *string

+ Acn *string

+ AgentFirstName *string

+ AgentLastName string

+ AgentRole string

+ BusinessName string

+ EstablishmentDate *string

+ IndustryCode *string

+ IndustryCodeVersion *CommonOrganisationDetailV2IndustryCodeVersion

+ IsACNCRegistered *bool

+ LastUpdateTime *string

+ LegalName *string

+ OrganisationType CommonOrganisationDetailV2OrganisationType

+ PhysicalAddresses []CommonPhysicalAddressWithPurpose

+ RegisteredCountry *string

+ ShortName *string

+ type CommonOrganisationDetailV2AllOf struct

+ PhysicalAddresses []CommonPhysicalAddressWithPurpose

+ type CommonOrganisationDetailV2IndustryCodeVersion string

+ const CommonOrganisationDetailV2IndustryCodeVersionANZSIC129202006V10

+ const CommonOrganisationDetailV2IndustryCodeVersionANZSIC129202006V20

+ type CommonOrganisationDetailV2OrganisationType string

+ const CommonOrganisationDetailV2OrganisationTypeCOMPANY

+ const CommonOrganisationDetailV2OrganisationTypeGOVERNMENTENTITY

+ const CommonOrganisationDetailV2OrganisationTypeOTHER

+ const CommonOrganisationDetailV2OrganisationTypePARTNERSHIP

+ const CommonOrganisationDetailV2OrganisationTypeSOLETRADER

+ const CommonOrganisationDetailV2OrganisationTypeTRUST

+ type CommonOrganisationIndustryCodeVersion string

+ const CommonOrganisationIndustryCodeVersionANZSIC129202006V10

+ const CommonOrganisationIndustryCodeVersionANZSIC129202006V20

+ type CommonOrganisationOrganisationType string

+ const CommonOrganisationOrganisationTypeCOMPANY

+ const CommonOrganisationOrganisationTypeGOVERNMENTENTITY

+ const CommonOrganisationOrganisationTypeOTHER

+ const CommonOrganisationOrganisationTypePARTNERSHIP

+ const CommonOrganisationOrganisationTypeSOLETRADER

+ const CommonOrganisationOrganisationTypeTRUST

+ type CommonPAFAddress struct

+ BuildingName1 *string

+ BuildingName2 *string

+ Dpid *string

+ FlatUnitNumber *string

+ FlatUnitType *string

+ FloorLevelNumber *string

+ FloorLevelType *string

+ LocalityName string

+ LotNumber *string

+ PostalDeliveryNumber *int

+ PostalDeliveryNumberPrefix *string

+ PostalDeliveryNumberSuffix *string

+ PostalDeliveryType *string

+ Postcode string

+ State string

+ StreetName *string

+ StreetSuffix *string

+ StreetType *string

+ ThoroughfareNumber1 *int

+ ThoroughfareNumber1Suffix *string

+ ThoroughfareNumber2 *int

+ ThoroughfareNumber2Suffix *string

+ type CommonPerson struct

+ FirstName *string

+ LastName string

+ LastUpdateTime *string

+ MiddleNames []string

+ OccupationCode *string

+ OccupationCodeVersion *CommonPersonOccupationCodeVersion

+ Prefix *string

+ Suffix *string

+ type CommonPersonDetailV2 struct

+ EmailAddresses []CommonEmailAddress

+ FirstName *string

+ LastName string

+ LastUpdateTime *string

+ MiddleNames []string

+ OccupationCode *string

+ OccupationCodeVersion *CommonPersonDetailV2OccupationCodeVersion

+ PhoneNumbers []CommonPhoneNumber

+ PhysicalAddresses []CommonPhysicalAddressWithPurpose

+ Prefix *string

+ Suffix *string

+ type CommonPersonDetailV2AllOf struct

+ EmailAddresses []CommonEmailAddress

+ PhoneNumbers []CommonPhoneNumber

+ PhysicalAddresses []CommonPhysicalAddressWithPurpose

+ type CommonPersonDetailV2OccupationCodeVersion string

+ const CommonPersonDetailV2OccupationCodeVersionANZSCO122002006V10

+ const CommonPersonDetailV2OccupationCodeVersionANZSCO122002006V11

+ const CommonPersonDetailV2OccupationCodeVersionANZSCO122002013V12

+ const CommonPersonDetailV2OccupationCodeVersionANZSCO122002013V13

+ type CommonPersonOccupationCodeVersion string

+ const CommonPersonOccupationCodeVersionANZSCO122002006V10

+ const CommonPersonOccupationCodeVersionANZSCO122002006V11

+ const CommonPersonOccupationCodeVersionANZSCO122002013V12

+ const CommonPersonOccupationCodeVersionANZSCO122002013V13

+ type CommonPhoneNumber struct

+ AreaCode *string

+ CountryCode *string

+ Extension *string

+ FullNumber string

+ IsPreferred *bool

+ Number string

+ Purpose CommonPhoneNumberPurpose

+ type CommonPhoneNumberPurpose string

+ const CommonPhoneNumberPurposeHOME

+ const CommonPhoneNumberPurposeINTERNATIONAL

+ const CommonPhoneNumberPurposeMOBILE

+ const CommonPhoneNumberPurposeOTHER

+ const CommonPhoneNumberPurposeUNSPECIFIED

+ const CommonPhoneNumberPurposeWORK

+ type CommonPhysicalAddress struct

+ AddressUType CommonPhysicalAddressAddressUType

+ Paf *CommonPAFAddress

+ Simple *CommonSimpleAddress

+ type CommonPhysicalAddressAddressUType string

+ const CommonPhysicalAddressAddressUTypePaf

+ const CommonPhysicalAddressAddressUTypeSimple

+ type CommonPhysicalAddressWithPurpose struct

+ AddressUType CommonPhysicalAddressWithPurposeAddressUType

+ Paf *CommonPAFAddress

+ Purpose CommonPhysicalAddressWithPurposePurpose

+ Simple *CommonSimpleAddress

+ type CommonPhysicalAddressWithPurposeAddressUType string

+ const CommonPhysicalAddressWithPurposeAddressUTypePaf

+ const CommonPhysicalAddressWithPurposeAddressUTypeSimple

+ type CommonPhysicalAddressWithPurposeAllOf struct

+ Purpose CommonPhysicalAddressWithPurposeAllOfPurpose

+ type CommonPhysicalAddressWithPurposeAllOfPurpose string

+ const CommonPhysicalAddressWithPurposeAllOfPurposeMAIL

+ const CommonPhysicalAddressWithPurposeAllOfPurposeOTHER

+ const CommonPhysicalAddressWithPurposeAllOfPurposePHYSICAL

+ const CommonPhysicalAddressWithPurposeAllOfPurposeREGISTERED

+ const CommonPhysicalAddressWithPurposeAllOfPurposeWORK

+ type CommonPhysicalAddressWithPurposePurpose string

+ const CommonPhysicalAddressWithPurposePurposeMAIL

+ const CommonPhysicalAddressWithPurposePurposeOTHER

+ const CommonPhysicalAddressWithPurposePurposePHYSICAL

+ const CommonPhysicalAddressWithPurposePurposeREGISTERED

+ const CommonPhysicalAddressWithPurposePurposeWORK

+ type CommonSimpleAddress struct

+ AddressLine1 string

+ AddressLine2 *string

+ AddressLine3 *string

+ City string

+ Country *string

+ MailingName *string

+ Postcode *string

+ State string

+ type DiscoveryOutage struct

+ Duration string

+ Explanation string

+ IsPartial *bool

+ OutageTime string

+ type GetCustomerDetailParams struct

+ XCdsClientHeaders *string

+ XFapiAuthDate *string

+ XFapiCustomerIpAddress *string

+ XFapiInteractionId *string

+ XMinV *string

+ XV string

+ type GetCustomerDetailResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *ResponseCommonCustomerDetailV2

+ JSON400 *ResponseErrorListV2

+ JSON406 *ResponseErrorListV2

+ func ParseGetCustomerDetailResponse(rsp *http.Response) (*GetCustomerDetailResponse, error)

+ func (r GetCustomerDetailResponse) Status() string

+ func (r GetCustomerDetailResponse) StatusCode() int

+ type GetCustomerParams struct

+ XCdsClientHeaders *string

+ XFapiAuthDate *string

+ XFapiCustomerIpAddress *string

+ XFapiInteractionId *string

+ XMinV *string

+ XV string

+ type GetCustomerResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *ResponseCommonCustomer

+ JSON400 *ResponseErrorListV2

+ JSON406 *ResponseErrorListV2

+ func ParseGetCustomerResponse(rsp *http.Response) (*GetCustomerResponse, error)

+ func (r GetCustomerResponse) Status() string

+ func (r GetCustomerResponse) StatusCode() int

+ type GetOutagesParams struct

+ XMinV *string

+ XV string

+ type GetOutagesResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *ResponseDiscoveryOutagesList

+ JSON400 *ResponseErrorListV2

+ JSON406 *ResponseErrorListV2

+ func ParseGetOutagesResponse(rsp *http.Response) (*GetOutagesResponse, error)

+ func (r GetOutagesResponse) Status() string

+ func (r GetOutagesResponse) StatusCode() int

+ type GetStatusParams struct

+ XMinV *string

+ XV string

+ type GetStatusResponse struct

+ Body []byte

+ HTTPResponse *http.Response

+ JSON200 *ResponseCommonDiscoveryStatus

+ JSON400 *ResponseErrorListV2

+ JSON406 *ResponseErrorListV2

+ func ParseGetStatusResponse(rsp *http.Response) (*GetStatusResponse, error)

+ func (r GetStatusResponse) Status() string

+ func (r GetStatusResponse) StatusCode() int

+ type HttpRequestDoer interface

+ Do func(req *http.Request) (*http.Response, error)

+ type Links struct

+ Self string

+ type Meta = map[string]interface

+ type MetaError struct

+ Urn *string

+ type RequestEditorFn func(ctx context.Context, req *http.Request) error

+ type ResponseCommonCustomer struct

+ Data ResponseCommonCustomerData

+ Links Links

+ Meta *Meta

+ type ResponseCommonCustomerData struct

+ CustomerUType ResponseCommonCustomerDataCustomerUType

+ Organisation *CommonOrganisation

+ Person *CommonPerson

+ type ResponseCommonCustomerDataCustomerUType string

+ const ResponseCommonCustomerDataCustomerUTypeOrganisation

+ const ResponseCommonCustomerDataCustomerUTypePerson

+ type ResponseCommonCustomerDetailV2 struct

+ Data ResponseCommonCustomerDetailV2Data

+ Links Links

+ Meta *Meta

+ type ResponseCommonCustomerDetailV2Data struct

+ CustomerUType ResponseCommonCustomerDetailV2DataCustomerUType

+ Organisation *CommonOrganisationDetailV2

+ Person *CommonPersonDetailV2

+ type ResponseCommonCustomerDetailV2DataCustomerUType string

+ const ResponseCommonCustomerDetailV2DataCustomerUTypeOrganisation

+ const ResponseCommonCustomerDetailV2DataCustomerUTypePerson

+ type ResponseCommonDiscoveryStatus struct

+ Data ResponseCommonDiscoveryStatusData

+ Links Links

+ Meta *Meta

+ type ResponseCommonDiscoveryStatusData struct

+ DetectionTime *string

+ ExpectedResolutionTime *string

+ Explanation *string

+ Status ResponseCommonDiscoveryStatusDataStatus

+ UpdateTime string

+ type ResponseCommonDiscoveryStatusDataStatus string

+ const OK

+ const PARTIALFAILURE

+ const SCHEDULEDOUTAGE

+ const UNAVAILABLE

+ type ResponseDiscoveryOutagesList struct

+ Data ResponseDiscoveryOutagesListData

+ Links Links

+ Meta *Meta

+ type ResponseDiscoveryOutagesListData struct

+ Outages []DiscoveryOutage

+ type ResponseErrorListV2 struct

+ Errors []ResponseErrorListV2Errors

+ type ResponseErrorListV2Errors struct

+ Code string

+ Detail string

+ Meta *MetaError

+ Title string