feat: openapi spec v1.22.1 (#23)

Author: notnmeyer

README.md

@@ -60,15 +60,15 @@ client := loops.NewClient("YOUR_API_KEY",
 - Audience segments — `GetAudienceSegment`, `ListAudienceSegments`, `CreateAudienceSegment`
 - Events — `SendEvent`
 - Event patterns — `ListEventPatterns`, `GetEventPatternByName`, `GetEventPattern`
-- Transactional — `SendTransactional`, `ListTransactionals`, `CreateTransactional`, `GetTransactional`, `UpdateTransactional`, `EnsureTransactionalDraft`, `PublishTransactional`
+- Transactional — `SendTransactional`, `ListTransactionals`, `CreateTransactional`, `GetTransactional`, `UpdateTransactional`, `EnsureTransactionalDraft`, `PublishTransactional`, `GetTransactionalMetrics`
 - Transactional groups — `CreateTransactionalGroup`, `GetTransactionalGroup`, `UpdateTransactionalGroup`, `ListTransactionalGroups`
 - Email messages — `GetEmailMessage`, `UpdateEmailMessage`, `PreviewEmailMessage`, `GetEmailMessageGuardian`
-- Campaigns — `CreateCampaign`, `UpdateCampaign`, `GetCampaign`, `ListCampaigns`
+- Campaigns — `CreateCampaign`, `UpdateCampaign`, `GetCampaign`, `ListCampaigns`, `GetCampaignMetrics`
 - Campaign groups — `CreateCampaignGroup`, `GetCampaignGroup`, `UpdateCampaignGroup`, `ListCampaignGroups`
 - Components — `GetComponent`, `ListComponents`, `CreateComponent`, `UpdateComponent`
 - Themes — `GetTheme`, `ListThemes`, `CreateTheme`, `UpdateTheme`
 - Uploads — `Upload`, `CreateUpload`, `CompleteUpload`
-- Workflows — `ListWorkflows`, `GetWorkflow`, `GetWorkflowNode`, `CreateWorkflow`, `UpdateWorkflow`, `DeleteWorkflow`, `ChangeWorkflowMailingList`, `CreateWorkflowNode`, `UpdateWorkflowNode`, `AddWorkflowBranch`, `RerouteNodeConnection`, `DeleteWorkflowNode`, `DeleteWorkflowNodeRecursive`
+- Workflows — `ListWorkflows`, `GetWorkflow`, `GetWorkflowNode`, `CreateWorkflow`, `UpdateWorkflow`, `DeleteWorkflow`, `ChangeWorkflowMailingList`, `CreateWorkflowNode`, `UpdateWorkflowNode`, `AddWorkflowBranch`, `RerouteNodeConnection`, `DeleteWorkflowNode`, `DeleteWorkflowNodeRecursive`, `GetWorkflowNodeMetrics`
 
 Full reference: [pkg.go.dev/github.com/loops-so/loops-go](https://pkg.go.dev/github.com/loops-so/loops-go).
 

campaigns.go

@@ -276,3 +276,44 @@ func (c *Client) ListCampaigns(params PaginationParams) ([]Campaign, *Pagination
 
 	return result.Data, &result.Pagination, nil
 }
+
+// EmailMetrics holds all-time email engagement counters, as returned by
+// [Client.GetCampaignMetrics] and [Client.GetWorkflowNodeMetrics]. Opens and
+// Clicks count sends, not events: a send opened five times counts once. A
+// recipient who received the email twice is counted once per send.
+type EmailMetrics struct {
+	Sends        int `json:"sends"`
+	Opens        int `json:"opens"`
+	Clicks       int `json:"clicks"`
+	Unsubscribes int `json:"unsubscribes"`
+	SpamReports  int `json:"spamReports"`
+	HardBounces  int `json:"hardBounces"`
+	SoftBounces  int `json:"softBounces"`
+}
+
+// GetCampaignMetrics returns all-time email engagement metrics for the
+// campaign identified by id. The server responds with a 400 error when the
+// campaign has not been sent yet or has no email message.
+func (c *Client) GetCampaignMetrics(id string) (*EmailMetrics, error) {
+	req, err := c.newRequest(http.MethodGet, "/campaigns/"+id+"/metrics", nil)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := c.do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, errorFromResponse(resp)
+	}
+
+	var result EmailMetrics
+	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
+		return nil, fmt.Errorf("failed to decode response: %w", err)
+	}
+
+	return &result, nil
+}

campaigns_test.go

@@ -682,3 +682,105 @@ func TestUpdateCampaign_NullableFields(t *testing.T) {
 		t.Errorf("name should not be sent, got %v", body["name"])
 	}
 }
+
+func TestGetCampaignMetrics(t *testing.T) {
+	want := EmailMetrics{
+		Sends:        4210,
+		Opens:        1922,
+		Clicks:       301,
+		Unsubscribes: 12,
+		SpamReports:  1,
+		HardBounces:  9,
+		SoftBounces:  13,
+	}
+
+	tests := []struct {
+		name       string
+		id         string
+		statusCode int
+		body       string
+		wantAPIErr *APIError
+		wantErrMsg string
+	}{
+		{
+			name:       "success",
+			id:         "cmp_abc123",
+			statusCode: http.StatusOK,
+			body:       `{"sends":4210,"opens":1922,"clicks":301,"unsubscribes":12,"spamReports":1,"hardBounces":9,"softBounces":13}`,
+		},
+		{
+			name:       "not found",
+			id:         "cmp_missing",
+			statusCode: http.StatusNotFound,
+			body:       `{"message":"Campaign not found."}`,
+			wantAPIErr: &APIError{StatusCode: http.StatusNotFound, Message: "Campaign not found."},
+		},
+		{
+			name:       "invalid id",
+			id:         "bad",
+			statusCode: http.StatusBadRequest,
+			body:       `{"message":"Invalid campaignId"}`,
+			wantAPIErr: &APIError{StatusCode: http.StatusBadRequest, Message: "Invalid campaignId"},
+		},
+		{
+			name:       "invalid json",
+			id:         "cmp_abc123",
+			statusCode: http.StatusOK,
+			body:       `not json`,
+			wantErrMsg: "failed to decode response",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var gotMethod, gotPath string
+			server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				gotMethod = r.Method
+				gotPath = r.URL.Path
+				w.WriteHeader(tt.statusCode)
+				w.Write([]byte(tt.body))
+			}))
+			defer server.Close()
+
+			client := NewClient("test-key", WithBaseURL(server.URL))
+			result, err := client.GetCampaignMetrics(tt.id)
+
+			if tt.wantAPIErr != nil {
+				var apiErr *APIError
+				if !errors.As(err, &apiErr) {
+					t.Fatalf("expected *APIError, got %T: %v", err, err)
+				}
+				if apiErr.StatusCode != tt.wantAPIErr.StatusCode {
+					t.Errorf("StatusCode = %d, want %d", apiErr.StatusCode, tt.wantAPIErr.StatusCode)
+				}
+				if apiErr.Message != tt.wantAPIErr.Message {
+					t.Errorf("Message = %q, want %q", apiErr.Message, tt.wantAPIErr.Message)
+				}
+				return
+			}
+
+			if tt.wantErrMsg != "" {
+				if err == nil {
+					t.Fatalf("expected error containing %q, got nil", tt.wantErrMsg)
+				}
+				if !strings.Contains(err.Error(), tt.wantErrMsg) {
+					t.Errorf("error = %q, want it to contain %q", err.Error(), tt.wantErrMsg)
+				}
+				return
+			}
+
+			if err != nil {
+				t.Fatalf("unexpected error: %v", err)
+			}
+			if gotMethod != http.MethodGet {
+				t.Errorf("method = %q, want GET", gotMethod)
+			}
+			if wantPath := "/campaigns/" + tt.id + "/metrics"; gotPath != wantPath {
+				t.Errorf("path = %q, want %q", gotPath, wantPath)
+			}
+			if *result != want {
+				t.Errorf("metrics = %+v, want %+v", *result, want)
+			}
+		})
+	}
+}

transactional_emails.go

@@ -233,3 +233,40 @@ func (c *Client) ListTransactionals(params PaginationParams) ([]Transactional, *
 
 	return result.Data, &result.Pagination, nil
 }
+
+// TransactionalMetrics holds all-time delivery counters for a transactional
+// email, as returned by [Client.GetTransactionalMetrics]. Counters are
+// totalled across every published version of the email.
+type TransactionalMetrics struct {
+	Sends       int `json:"sends"`
+	Deliveries  int `json:"deliveries"`
+	SpamReports int `json:"spamReports"`
+	HardBounces int `json:"hardBounces"`
+	SoftBounces int `json:"softBounces"`
+}
+
+// GetTransactionalMetrics returns all-time delivery metrics for the
+// transactional email identified by id.
+func (c *Client) GetTransactionalMetrics(id string) (*TransactionalMetrics, error) {
+	req, err := c.newRequest(http.MethodGet, "/transactional-emails/"+id+"/metrics", nil)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := c.do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, errorFromResponse(resp)
+	}
+
+	var result TransactionalMetrics
+	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
+		return nil, fmt.Errorf("failed to decode response: %w", err)
+	}
+
+	return &result, nil
+}

transactional_emails_test.go

@@ -715,3 +715,103 @@ func TestListTransactionals_QueryParams(t *testing.T) {
 		})
 	}
 }
+
+func TestGetTransactionalMetrics(t *testing.T) {
+	want := TransactionalMetrics{
+		Sends:       4210,
+		Deliveries:  4175,
+		SpamReports: 1,
+		HardBounces: 9,
+		SoftBounces: 13,
+	}
+
+	tests := []struct {
+		name       string
+		id         string
+		statusCode int
+		body       string
+		wantAPIErr *APIError
+		wantErrMsg string
+	}{
+		{
+			name:       "success",
+			id:         "tx_abc123",
+			statusCode: http.StatusOK,
+			body:       `{"sends":4210,"deliveries":4175,"spamReports":1,"hardBounces":9,"softBounces":13}`,
+		},
+		{
+			name:       "not found",
+			id:         "tx_missing",
+			statusCode: http.StatusNotFound,
+			body:       `{"message":"Transactional email not found."}`,
+			wantAPIErr: &APIError{StatusCode: http.StatusNotFound, Message: "Transactional email not found."},
+		},
+		{
+			name:       "invalid id",
+			id:         "bad",
+			statusCode: http.StatusBadRequest,
+			body:       `{"message":"Invalid transactionalId"}`,
+			wantAPIErr: &APIError{StatusCode: http.StatusBadRequest, Message: "Invalid transactionalId"},
+		},
+		{
+			name:       "invalid json",
+			id:         "tx_abc123",
+			statusCode: http.StatusOK,
+			body:       `not json`,
+			wantErrMsg: "failed to decode response",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var gotMethod, gotPath string
+			server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+				gotMethod = r.Method
+				gotPath = r.URL.Path
+				w.WriteHeader(tt.statusCode)
+				w.Write([]byte(tt.body))
+			}))
+			defer server.Close()
+
+			client := NewClient("test-key", WithBaseURL(server.URL))
+			result, err := client.GetTransactionalMetrics(tt.id)
+
+			if tt.wantAPIErr != nil {
+				var apiErr *APIError
+				if !errors.As(err, &apiErr) {
+					t.Fatalf("expected *APIError, got %T: %v", err, err)
+				}
+				if apiErr.StatusCode != tt.wantAPIErr.StatusCode {
+					t.Errorf("StatusCode = %d, want %d", apiErr.StatusCode, tt.wantAPIErr.StatusCode)
+				}
+				if apiErr.Message != tt.wantAPIErr.Message {
+					t.Errorf("Message = %q, want %q", apiErr.Message, tt.wantAPIErr.Message)
+				}
+				return
+			}
+
+			if tt.wantErrMsg != "" {
+				if err == nil {
+					t.Fatalf("expected error containing %q, got nil", tt.wantErrMsg)
+				}
+				if !strings.Contains(err.Error(), tt.wantErrMsg) {
+					t.Errorf("error = %q, want it to contain %q", err.Error(), tt.wantErrMsg)
+				}
+				return
+			}
+
+			if err != nil {
+				t.Fatalf("unexpected error: %v", err)
+			}
+			if gotMethod != http.MethodGet {
+				t.Errorf("method = %q, want GET", gotMethod)
+			}
+			if wantPath := "/transactional-emails/" + tt.id + "/metrics"; gotPath != wantPath {
+				t.Errorf("path = %q, want %q", gotPath, wantPath)
+			}
+			if *result != want {
+				t.Errorf("metrics = %+v, want %+v", *result, want)
+			}
+		})
+	}
+}

version.go

@@ -10,7 +10,7 @@ import "runtime/debug"
 var Version = readVersion()
 
 // SpecVersion is the Loops OpenAPI spec version this SDK is built against.
-const SpecVersion = "1.21.14"
+const SpecVersion = "1.22.1"
 
 const modulePath = "github.com/loops-so/loops-go"
 

workflows.go

@@ -825,6 +825,35 @@ func (c *Client) GetWorkflowNode(workflowID, nodeID string) (*WorkflowNodeWithRe
 	return &result, nil
 }
 
+// GetWorkflowNodeMetrics returns all-time email engagement metrics for the
+// SendEmailAction node identified by nodeID in the workflow identified by
+// workflowID. The server responds with a 400 error for nodes of any other
+// type or for a node with no email message. A SendEmailAction node that has
+// not sent anything yet reports every counter as 0.
+func (c *Client) GetWorkflowNodeMetrics(workflowID, nodeID string) (*EmailMetrics, error) {
+	req, err := c.newRequest(http.MethodGet, "/workflows/"+workflowID+"/nodes/"+nodeID+"/metrics", nil)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := c.do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return nil, errorFromResponse(resp)
+	}
+
+	var result EmailMetrics
+	if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
+		return nil, fmt.Errorf("failed to decode response: %w", err)
+	}
+
+	return &result, nil
+}
+
 // WorkflowMutationNode is the detailed node returned by workflow mutations
 // (create, update, add-branch). Unlike [WorkflowNode] it omits workflowId and
 // its variant fields differ. Exactly one variant pointer is set; TypeName is