Skip to content

Latest commit

 

History

History
322 lines (242 loc) · 18.8 KB

README.md

File metadata and controls

322 lines (242 loc) · 18.8 KB
Raw

Customer

(Customer)

Overview

Available Operations

CreateTicketingCustomer

Create a customer

Example Usage

package main

import(
	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()
    request := operations.CreateTicketingCustomerRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Customer.CreateTicketingCustomer(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingCustomer != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.CreateTicketingCustomerResponse, error

Errors

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

GetTicketingCustomer

Retrieve a customer

Example Usage

package main

import(
	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()
    request := operations.GetTicketingCustomerRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Customer.GetTicketingCustomer(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingCustomer != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.GetTicketingCustomerResponse, error

Errors

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

ListTicketingCustomers

List all customers

Example Usage

package main

import(
	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()
    request := operations.ListTicketingCustomersRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Customer.ListTicketingCustomers(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingCustomers != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.ListTicketingCustomersResponse, error

Errors

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

PatchTicketingCustomer

Update a customer

Example Usage

package main

import(
	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()
    request := operations.PatchTicketingCustomerRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Customer.PatchTicketingCustomer(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingCustomer != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.PatchTicketingCustomerResponse, error

Errors

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

RemoveTicketingCustomer

Remove a customer

Example Usage

package main

import(
	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()
    request := operations.RemoveTicketingCustomerRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Customer.RemoveTicketingCustomer(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.RemoveTicketingCustomerRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.RemoveTicketingCustomerResponse, error

Errors

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

UpdateTicketingCustomer

Update a customer

Example Usage

package main

import(
	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()
    request := operations.UpdateTicketingCustomerRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Customer.UpdateTicketingCustomer(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.TicketingCustomer != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.UpdateTicketingCustomerResponse, error

Errors

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