goth: Index | Files

package xero

import ""

Package xero implements the OAuth protocol for authenticating users through Xero.


Package Files

session.go xero.go

type APIResponse Uses

type APIResponse struct {
    Organisations []Organisation `json:"Organisations,omitempty"`

APIResponse is the Total response from the Xero API

type Organisation Uses

type Organisation struct {
    // Display name of organisation shown in Xero
    Name string `json:"Name,omitempty"`

    // Organisation name shown on Reports
    LegalName string `json:"LegalName,omitempty"`

    // Organisation Type
    OrganisationType string `json:"OrganisationType,omitempty"`

    // Country code for organisation. See ISO 3166-2 Country Codes
    CountryCode string `json:"CountryCode,omitempty"`

    // A unique identifier for the organisation. Potential uses.
    ShortCode string `json:"ShortCode,omitempty"`

Organisation is the expected response from the Organisation endpoint - this is not a complete schema

type Provider Uses

type Provider struct {
    ClientKey   string
    Secret      string
    CallbackURL string
    HTTPClient  *http.Client
    Method      string
    // contains filtered or unexported fields

Provider is the implementation of `goth.Provider` for accessing Xero.

func New Uses

func New(clientKey, secret, callbackURL string) *Provider

New creates a new Xero provider, and sets up important connection details. You should always call `xero.New` to get a new Provider. Never try to create one manually.

func (*Provider) BeginAuth Uses

func (p *Provider) BeginAuth(state string) (goth.Session, error)

BeginAuth asks Xero for an authentication end-point and a request token for a session. Xero does not support the "state" variable.

func (*Provider) Client Uses

func (p *Provider) Client() *http.Client

Client does pretty much everything

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug sets the logging of the OAuth client to verbose.

func (*Provider) FetchUser Uses

func (p *Provider) FetchUser(session goth.Session) (goth.User, error)

FetchUser will go to Xero and access basic information about the user.

func (*Provider) Name Uses

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshOAuth1Token Uses

func (p *Provider) RefreshOAuth1Token(session *Session) error

RefreshOAuth1Token should be used instead of RefeshToken which is not compliant with the Oauth1.0a standard

func (*Provider) RefreshToken Uses

func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)

RefreshToken refresh token is not provided by the Xero Public or Private Application - only the Partner Application and you must use RefreshOAuth1Token instead

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by the Xero Public or Private Application - only the Partner Application and you must use RefreshOAuth1Token instead

func (*Provider) SetName Uses

func (p *Provider) SetName(name string)

SetName is to update the name of the provider (needed in case of multiple providers of 1 type)

func (*Provider) UnmarshalSession Uses

func (p *Provider) UnmarshalSession(data string) (goth.Session, error)

UnmarshalSession will unmarshal a JSON string into a session.

type Session Uses

type Session struct {
    AuthURL            string
    AccessToken        *oauth.AccessToken
    RequestToken       *oauth.RequestToken
    AccessTokenExpires time.Time

Session stores data during the auth process with Xero.

func (*Session) Authorize Uses

func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)

Authorize the session with Xero and return the access token to be stored for future use.

func (Session) GetAuthURL Uses

func (s Session) GetAuthURL() (string, error)

GetAuthURL will return the URL set by calling the `BeginAuth` function on the Xero provider.

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String Uses

func (s Session) String() string

Package xero imports 14 packages (graph) and is imported by 19 packages. Updated 2017-05-23. Refresh now. Tools for package owners.