cmd

Documentation

Overview

Copyright © 2020 Hover Developer Services <support@usehover.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 Hover Developer Services <support@usehover.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 Hover Developer Services <support@usehover.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 Hover Developer Services <support@usehover.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright © 2020 Hover Developer Services <support@usehover.com>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func APIRequest(method string, endpoint string, payload []byte) (*http.Response, error)
• func Authenticate() error
• func Execute()
• type Action
• type ActionDetails
• type ActionListResponse
• type ActionRequest
• type ActionResponse

Constants

const URL = "https://stage.usehover.com/api/"

URL points to the Hover API url

Functions

func APIRequest

func APIRequest(method string, endpoint string, payload []byte) (*http.Response, error)

APIRequest makes a request to the Hover API The request has an Authorization header.

func Authenticate

func Authenticate() error

Authenticate checks if a valid token exists. If the token is expired then a new one is requested

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

Types

type Action

type Action struct {
	ID         string                 `json:"id"`
	Attributes map[string]interface{} `json:"attributes"`
}

Action struct represents an Action object

type ActionDetails

type ActionDetails struct {
	Name           string   `json:"name,omitempty"`
	RootCode       string   `json:"root_code,omitempty"`
	TransportType  string   `json:"transport_type,omitempty"`
	WorldOperators []string `json:"world_operator_ids,omitempty"`
}

ActionDetails contains the Action fields used in ActionRequest

type ActionListResponse

type ActionListResponse struct {
	Data []Action
}

ActionListResponse struct represents a response containing a list of actions

type ActionRequest

type ActionRequest struct {
	CustomAction ActionDetails `json:"custom_action"`
}

ActionRequest is the request object when creating actions

type ActionResponse

type ActionResponse struct {
	Data Action
}

ActionResponse struct represents an action response