README.md

Group

(Group)

Available Operations

• CreateHrisGroup - Create a group
• GetHrisGroup - Retrieve a group
• ListHrisGroups - List all groups
• PatchHrisGroup - Update a group
• RemoveHrisGroup - Remove a group
• UpdateHrisGroup - Update a group

CreateHrisGroup

Create a group

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(
        unifiedgosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    request := operations.CreateHrisGroupRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Group.CreateHrisGroup(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.HrisGroup != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.CreateHrisGroupRequest	✔️	The request object to use for the request.

Response

*operations.CreateHrisGroupResponse, error

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

GetHrisGroup

Retrieve a group

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(
        unifiedgosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    request := operations.GetHrisGroupRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Group.GetHrisGroup(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.HrisGroup != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.GetHrisGroupRequest	✔️	The request object to use for the request.

Response

*operations.GetHrisGroupResponse, error

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

ListHrisGroups

List all groups

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(
        unifiedgosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    request := operations.ListHrisGroupsRequest{
        ConnectionID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Group.ListHrisGroups(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.HrisGroups != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.ListHrisGroupsRequest	✔️	The request object to use for the request.

Response

*operations.ListHrisGroupsResponse, error

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

PatchHrisGroup

Update a group

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(
        unifiedgosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    request := operations.PatchHrisGroupRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Group.PatchHrisGroup(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.HrisGroup != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.PatchHrisGroupRequest	✔️	The request object to use for the request.

Response

*operations.PatchHrisGroupResponse, error

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

RemoveHrisGroup

Remove a group

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(
        unifiedgosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    request := operations.RemoveHrisGroupRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Group.RemoveHrisGroup(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.RemoveHrisGroupRequest	✔️	The request object to use for the request.

Response

*operations.RemoveHrisGroupResponse, error

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

UpdateHrisGroup

Update a group

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(
        unifiedgosdk.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    request := operations.UpdateHrisGroupRequest{
        ConnectionID: "<value>",
        ID: "<id>",
    }
    ctx := context.Background()
    res, err := s.Group.UpdateHrisGroup(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.HrisGroup != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.UpdateHrisGroupRequest	✔️	The request object to use for the request.

Response

*operations.UpdateHrisGroupResponse, error

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