zendesk

package module
v0.0.0-...-c21390b Latest Latest
Warning

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

Go to latest
Published: Sep 5, 2018 License: MIT Imports: 9 Imported by: 0

README

zendesk

zendesk api wrapper for golang.

Travis branch Codecov branch Go Report Card GoDoc

Installation

$ go get -u github.com/go-zendesk/zendesk

API Status

List Users
  • GET /api/v2/users.json
  • GET /api/v2/groups/{id}/users.json
  • GET /api/v2/organizations/{id}/users.json
Show User
  • GET /api/v2/users/{id}.json
Show Many Users
  • GET /api/v2/users/show_many.json?ids={ids}
  • GET /api/v2/users/show_many.json?external_ids={external_ids}
  • GET /api/v2/users/{id}/related.json
Create User
  • POST /api/v2/users.json
Create Or Update Many Users
  • POST /api/v2/users/create_or_update_many.json
Merge Self With Another User
  • [ ]PUT /api/v2/users/me/merge.json
Merge End Users
  • PUT /api/v2/users/{id}/merge.json
Create Many Users
  • POST /api/v2/users/create_many.json
Update User
  • PUT /api/v2/users/{id}.json
Update Many Users
  • PUT /api/v2/users/update_many.json
  • PUT /api/v2/users/update_many.json?ids={ids}
  • PUT /api/v2/users/update_many.json?external_ids={external_ids}
Bulk Deleting Users
  • DELETE /api/v2/users/destroy_many.json?ids={ids}
  • DELETE /api/v2/users/destroy_many.json?external_ids={external_ids}
Delete User
  • DELETE /api/v2/users/{id}.json
Search Users
  • GET /api/v2/users/search.json?query={query}
  • GET /api/v2/users/search.json?external_id={external_id}
Autocomplete Users
  • GET /api/v2/users/autocomplete.json?name={name}
Request User Create
  • POST /api/v2/users/request_create.json
Show the Currently Authenticated User
  • GET /api/v2/users/me.json
Set a User's Password
  • POST /api/v2/users/{user_id}/password.json
Change Your Password
  • PUT /api/v2/users/{user_id}/password.json
Get a list of password requirements
  • GET /api/v2/users/{user_id}/password/requirements.json

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Request

type Request struct {
	*gorequest.SuperAgent

	Errors []error
	// contains filtered or unexported fields
}

func New

func New(subDomain string) *Request

func (*Request) ApiTokenAuth

func (b *Request) ApiTokenAuth(emailAddress, apiToken string) *Request

func (*Request) BasicAuth

func (b *Request) BasicAuth(emailAddress, password string) *Request

func (*Request) Debug

func (b *Request) Debug(enable bool) *Request

func (*Request) GroupUsers

func (b *Request) GroupUsers(id int) *usersRequest

GET /api/v2/groups/{id}/users.json

func (*Request) Oauth2Auth

func (b *Request) Oauth2Auth(accessToken string) *Request

func (*Request) OrganizationUsers

func (b *Request) OrganizationUsers(id int) *usersRequest

GET /api/v2/organizations/{id}/users.json

func (*Request) ShowMany

func (b *Request) ShowMany(ids string) *usersRequest

GET /api/v2/users/show_many.json?ids={ids}

func (*Request) Tickets

func (b *Request) Tickets() *Request

func (*Request) User

func (b *Request) User(id int) *usersRequest

GET /api/v2/users/{id}.json

func (*Request) Users

func (b *Request) Users() *usersRequest

GET /api/v2/users.json

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL