Skip to content

Latest commit

 

History

History
321 lines (253 loc) · 17.8 KB

README.md

File metadata and controls

321 lines (253 loc) · 17.8 KB
Raw

Note

(Note)

Available Operations

CreateTicketingNote

Create a note

Example Usage

package main

import(
	"os"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New(
        unifiedgosdk.WithSecurity(os.Getenv("JWT")),
    )
    request := operations.CreateTicketingNoteRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Note.CreateTicketingNote(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingNote != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.CreateTicketingNoteRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.CreateTicketingNoteResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

GetTicketingNote

Retrieve a note

Example Usage

package main

import(
	"os"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New(
        unifiedgosdk.WithSecurity(os.Getenv("JWT")),
    )
    request := operations.GetTicketingNoteRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Note.GetTicketingNote(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingNote != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.GetTicketingNoteRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.GetTicketingNoteResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

ListTicketingNotes

List all notes

Example Usage

package main

import(
	"os"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New(
        unifiedgosdk.WithSecurity(os.Getenv("JWT")),
    )
    request := operations.ListTicketingNotesRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Note.ListTicketingNotes(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingNotes != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.ListTicketingNotesRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.ListTicketingNotesResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

PatchTicketingNote

Update a note

Example Usage

package main

import(
	"os"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New(
        unifiedgosdk.WithSecurity(os.Getenv("JWT")),
    )
    request := operations.PatchTicketingNoteRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Note.PatchTicketingNote(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingNote != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.PatchTicketingNoteRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.PatchTicketingNoteResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

RemoveTicketingNote

Remove a note

Example Usage

package main

import(
	"os"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New(
        unifiedgosdk.WithSecurity(os.Getenv("JWT")),
    )
    request := operations.RemoveTicketingNoteRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Note.RemoveTicketingNote(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.RemoveTicketingNoteRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.RemoveTicketingNoteResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /

UpdateTicketingNote

Update a note

Example Usage

package main

import(
	"os"
	unifiedgosdk "github.com/unified-to/unified-go-sdk"
	"github.com/unified-to/unified-go-sdk/pkg/models/operations"
	"context"
	"log"
)

func main() {
    s := unifiedgosdk.New(
        unifiedgosdk.WithSecurity(os.Getenv("JWT")),
    )
    request := operations.UpdateTicketingNoteRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Note.UpdateTicketingNote(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingNote != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.UpdateTicketingNoteRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.UpdateTicketingNoteResponse, error

Error Object Status Code Content Type
sdkerrors.SDKError 4xx-5xx /