README.md

Campaigns

(Campaigns)

Overview

Campaigns

Available Operations

• GetAllCampaignEvents - Get all campaign events
• GetCampaignEvent - Get a campaign event details
• SaveCampaignEvent - Update an existing event
• DeleteCampaignEvent - Delete a campaign event details
• GetEventsCampaign - Get campaign events for a campaign
• ScheduleCampaign - Schedule a campaign event for a campaign

GetAllCampaignEvents

Get all campaign events

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"github.com/infra-rdc/rudder-go/models/components"
	"github.com/infra-rdc/rudder-go/models/operations"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    request := operations.GetAllCampaignEventsRequest{
        CampaignType: components.CampaignTypeSystemUpdate.ToPointer(),
        State: components.CampaignEventStatusRunning.ToPointer(),
        CampaignID: components.CampaignIDSystemUpdate.ToPointer(),
    }
    ctx := context.Background()
    res, err := s.Campaigns.GetAllCampaignEvents(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.GetAllCampaignEventsResponse, error

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

GetCampaignEvent

Get a campaign event details

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var id string = "0076a379-f32d-4732-9e91-33ab219d8fde"
    ctx := context.Background()
    res, err := s.Campaigns.GetCampaignEvent(ctx, id)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
ctx	context.Context	✔️	The context to use for the request.
id	string	✔️	Id of the campaign event	0076a379-f32d-4732-9e91-33ab219d8fde

Response

*operations.GetCampaignEventResponse, error

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

SaveCampaignEvent

Update an existing event

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var id string = "0076a379-f32d-4732-9e91-33ab219d8fde"
    ctx := context.Background()
    res, err := s.Campaigns.SaveCampaignEvent(ctx, id)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
ctx	context.Context	✔️	The context to use for the request.
id	string	✔️	Id of the campaign event	0076a379-f32d-4732-9e91-33ab219d8fde

Response

*operations.SaveCampaignEventResponse, error

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

DeleteCampaignEvent

Delete a campaign event details

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var id string = "0076a379-f32d-4732-9e91-33ab219d8fde"
    ctx := context.Background()
    res, err := s.Campaigns.DeleteCampaignEvent(ctx, id)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
ctx	context.Context	✔️	The context to use for the request.
id	string	✔️	Id of the campaign event	0076a379-f32d-4732-9e91-33ab219d8fde

Response

*operations.DeleteCampaignEventResponse, error

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

GetEventsCampaign

Get campaign events for a campaign

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"github.com/infra-rdc/rudder-go/models/components"
	"github.com/infra-rdc/rudder-go/models/operations"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    request := operations.GetEventsCampaignRequest{
        ID: "0076a379-f32d-4732-9e91-33ab219d8fde",
        CampaignType: components.CampaignTypeSystemUpdate.ToPointer(),
        State: components.CampaignEventStatusScheduled.ToPointer(),
    }
    ctx := context.Background()
    res, err := s.Campaigns.GetEventsCampaign(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.GetEventsCampaignResponse, error

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

ScheduleCampaign

Schedule a campaign event for a campaign

Example Usage

package main

import(
	rudder "github.com/infra-rdc/rudder-go"
	"context"
	"log"
)

func main() {
    s := rudder.New(
        rudder.WithSecurity("<YOUR_API_KEY_HERE>"),
    )
    var id string = "0076a379-f32d-4732-9e91-33ab219d8fde"
    ctx := context.Background()
    res, err := s.Campaigns.ScheduleCampaign(ctx, id)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description	Example
ctx	context.Context	✔️	The context to use for the request.
id	string	✔️	Id of the campaign	0076a379-f32d-4732-9e91-33ab219d8fde

Response

*operations.ScheduleCampaignResponse, error

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