feat/add-audience-feed-error-method-response-interface

CHANGELOG.md

@@ -1,8 +1,21 @@
 # Changelog
 
+# 0.10.1
+
+- add new AudienceFeedMethodErrorResponse interface in prevision of the error handling:
+
+```
+export interface AudienceFeedMethodErrorResponse {
+  error_code?: string;
+  error_origin?: string;
+}
+
+```
+
 # 0.10.0 - 2022-10-28
 
 Breaking changes in UserSegmentUpdatePluginResponse.
+
 - update the Audience feed onUserSegmentUpdate method return type. Interface UserSegmentUpdatePluginResponse data optional element is now of type DeliveryType.
 - status can be 'no_eligible_identifier' now (status code 400);
 - stats field is changed (UserSegmentUpdatePluginResponseStats);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mediarithmics/plugins-nodejs-sdk",
-  "version": "0.10.0",
+  "version": "0.10.1",
   "description": "This is the mediarithmics nodejs to help plugin developers bootstrapping their plugin without having to deal with most of the plugin boilerplate",
   "repository": "github:MEDIARITHMICS/plugins-nodejs-sdk",
   "main": "./lib/index.js",

src/mediarithmics/api/plugin/audiencefeedconnector/AudienceFeedConnectorPluginResponseInterface.ts

@@ -2,7 +2,7 @@ export type AudienceFeedConnectorStatus = 'ok' | 'error';
 export declare type AudienceFeedConnectorConnectionStatus = 'ok' | 'error' | 'external_segment_not_ready_yet';
 export type AudienceFeedConnectorContentType = 'text/csv' | 'application/json' | 'text/plain';
 
-export interface UserSegmentUpdatePluginResponse {
+export interface UserSegmentUpdatePluginResponse extends AudienceFeedMethodErrorResponse {
   status: UserSegmentUpdatePluginResponseStatus;
   data?: DeliveryType[];
   stats?: UserSegmentUpdatePluginResponseStats[];
@@ -37,13 +37,13 @@ export interface UserSegmentUpdatePluginResponseStats {
   tags?: AudienceFeedStatTag[];
 }
 
-export interface ExternalSegmentCreationPluginResponse {
+export interface ExternalSegmentCreationPluginResponse extends AudienceFeedMethodErrorResponse {
   status: AudienceFeedConnectorStatus;
   message?: string;
   visibility?: 'PRIVATE' | 'PUBLIC';
 }
 
-export interface ExternalSegmentConnectionPluginResponse {
+export interface ExternalSegmentConnectionPluginResponse extends AudienceFeedMethodErrorResponse {
   status: AudienceFeedConnectorConnectionStatus;
   message?: string;
 }
@@ -54,3 +54,8 @@ export interface AudienceFeedStatTag {
   key: string;
   value: string;
 }
+
+export interface AudienceFeedMethodErrorResponse {
+  error_code?: string;
+  error_origin?: string;
+}