stork

Documentation

Overview

Package stork contains utilities for communicating with the Stork API, which creates test eSIM profiles.

Index

• Constants
• func FetchStorkProfile(ctx context.Context) (ActivationCode, CleanupProfileFunc, error)
• type ActivationCode
• type CleanupProfileFunc
• type ProfileListData
• type RequestData

Constants

const (
	// CleanupProfileTime is the time which should be allocated for running a CleanupProfileFunc.
	CleanupProfileTime = 1 * time.Minute
)

Functions

func FetchStorkProfile

func FetchStorkProfile(ctx context.Context) (ActivationCode, CleanupProfileFunc, error)

FetchStorkProfile fetches a test eSIM profile from Stork.

Types

type ActivationCode

type ActivationCode string

ActivationCode to be used to install an eSIM profile.

type CleanupProfileFunc

type CleanupProfileFunc func(ctx context.Context) error

CleanupProfileFunc alerts Stork that the profile has been used.

type ProfileListData

type ProfileListData struct {
	Eid                         string `json:"eid"`
	ConfirmationCode            string `json:"confirmationCode"`
	MaxConfirmationCodeAttempts int    `json:"maxConfirmationCodeAttempts"`
	MaxDownloadAttempts         int    `json:"maxDownloadAttempts"`
	ProfileStatus               string `json:"profileStatus"`
	ProfileClass                string `json:"profileClass"`
	ServiceProviderName         string `json:"serviceProviderName"`
	GenerateSmdsEvent           bool   `json:"generateSmdsEvent"`
	ProfilePolicyRules          []int  `json:"profilePolicyRules"`
}

ProfileListData represents the JSON structure of profile list metadata sent to Stork.

type RequestData

type RequestData struct {
	GtsTestProfileList []ProfileListData `json:"gtsTestProfileList"`
	Eid                string            `json:"eid"`
}

RequestData represents the JSON structure of an eSIM profile request sent to Stork.