snow

Documentation

Overview

Copyright © 2022 ITRS Group

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 ITRS Group

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 ITRS Group

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright © 2022 ITRS Group

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• func AssembleRequest(t RequestTransitive, table string) (req *http.Request)
• type Connection
  • func InitializeConnection(cf settings.Settings, password string) *Connection
  • func (c Connection) GET(limit string, fields string, offset string, query string, sysID string) (t RequestTransitive)
  • func (c Connection) POST(payload []byte, limit string, fields string, offset string, query string, ...) (t RequestTransitive)
  • func (c Connection) PUT(payload []byte, limit string, fields string, offset string, query string, ...) (t RequestTransitive)
• type RequestTransitive
  • func (t RequestTransitive) QueryTable(table string) (i ResultsArray, err error)
  • func (t RequestTransitive) QueryTableDetail(table string) (r ResultDetail, err error)
  • func (t RequestTransitive) QueryTableSingle(table string) (i ResultDetail, err error)
• type ResultDetail
• type ResultsArray
• type SNOWError

Functions

func AssembleRequest

func AssembleRequest(t RequestTransitive, table string) (req *http.Request)

Types

type Connection

type Connection struct {
	Client   *http.Client
	Instance string
	Username string
	Password string
}

func InitializeConnection

func InitializeConnection(cf settings.Settings, password string) *Connection

func (Connection) GET

func (c Connection) GET(limit string, fields string, offset string, query string, sysID string) (t RequestTransitive)

func (Connection) POST

func (c Connection) POST(payload []byte, limit string, fields string, offset string, query string, sysID string) (t RequestTransitive)

func (Connection) PUT

func (c Connection) PUT(payload []byte, limit string, fields string, offset string, query string, sysID string) (t RequestTransitive)

type RequestTransitive

type RequestTransitive struct {
	Connection
	Payload []byte
	Method  string
	Parms   url.Values
	SysID   string
}

func (RequestTransitive) QueryTable

func (t RequestTransitive) QueryTable(table string) (i ResultsArray, err error)

func (RequestTransitive) QueryTableDetail

func (t RequestTransitive) QueryTableDetail(table string) (r ResultDetail, err error)

func (RequestTransitive) QueryTableSingle

func (t RequestTransitive) QueryTableSingle(table string) (i ResultDetail, err error)

type ResultDetail

type ResultDetail map[string]string

type ResultsArray

type ResultsArray []ResultDetail

type SNOWError

type SNOWError struct {
	Error struct {
		Message string `json:"message"`
		Detail  string `json:"detail"`
	} `json:"error"`
	Status string `json:"status"`
}