need4deed-sdk 0.0.168 → 0.0.170

package/dist/constants/endpoints.d.ts

@@ -5,5 +5,6 @@ export declare enum Endpoint {
     VOLUNTEER = "/volunteer",
     OPTION = "/option",
     AGENT = "/agent",
-    REGISTER = "/register"
+    REGISTER = "/register",
+    STATISTICS = "/statistics"
 }

package/dist/constants/endpoints.js

@@ -10,4 +10,5 @@ var Endpoint;
     Endpoint["OPTION"] = "/option";
     Endpoint["AGENT"] = "/agent";
     Endpoint["REGISTER"] = "/register";
+    Endpoint["STATISTICS"] = "/statistics";
 })(Endpoint || (exports.Endpoint = Endpoint = {}));

package/dist/types/api/agent.d.ts

@@ -103,6 +103,7 @@ interface AgentGetList {
     unclaimed: boolean;
     lat: number | null;
     lon: number | null;
+    statusEngagement: AgentEngagementStatusType;
 }
 export type ApiAgentGetList = VoidableProps<AgentGetList, "district">;
 interface AgentGet extends AgentGetList {
@@ -112,7 +113,6 @@ interface AgentGet extends AgentGetList {
     representative: ApiRepresentativeGet;
     contacts: ApiAgentMembership[];
     services: Service[];
-    statusEngagement: AgentEngagementStatusType;
     agentDetails: AgentDetails;
     comments: ApiComment[];
     languages: ApiLanguage[];
@@ -144,6 +144,7 @@ export interface ApiAgentRegisterNew {
     addressStreet?: string;
     addressPostcode?: string;
     languages?: number[];
+    confirmSharedAddress?: boolean;
 }
 export type ApiAgentRegister = {
     agentId: number;
@@ -158,6 +159,12 @@ export interface ApiAgentRegisterResponse {
     agentId: number;
     membershipStatus: AgentMembershipStatus;
 }
+export interface ApiAgentRegisterStatus {
+    registered: boolean;
+    agentId?: number;
+    agentTitle?: string;
+    membershipStatus?: AgentMembershipStatus;
+}
 export interface ApiAgentCreateResponse {
     agentId: number;
 }
@@ -169,7 +176,12 @@ export interface ApiAgentAddressConflict {
     conflict: "address";
     agentId: number;
 }
-export type ApiAgentRegisterConflict = ApiAgentTitleConflict | ApiAgentAddressConflict;
+export interface ApiAgentAlreadyRegisteredConflict {
+    conflict: "registered";
+    agentId: number;
+    membershipStatus: AgentMembershipStatus;
+}
+export type ApiAgentRegisterConflict = ApiAgentTitleConflict | ApiAgentAddressConflict | ApiAgentAlreadyRegisteredConflict;
 export interface ApiAgentMembership {
     id: number;
     agentId: number;

package/dist/types/api/event.d.ts

@@ -42,11 +42,11 @@ export interface ApiEventN4DGetList {
     description: string;
     shortDescription: string;
     linkRSVP: string;
+    hostName?: string;
     additionalTitle?: string;
     additionalInfo?: string[];
 }
 export interface ApiEventN4DGet extends ApiEventN4DGetList {
-    hostName?: string;
     time?: string;
     locationLink?: string;
     followUpText?: string;

package/dist/types/api/index.d.ts

@@ -18,6 +18,7 @@ export * from "./post-reply";
 export * from "./organization";
 export * from "./person";
 export * from "./profile";
+export * from "./statistics";
 export * from "./testimonial";
 export * from "./time";
 export * from "./translation";

package/dist/types/api/index.js

@@ -34,6 +34,7 @@ __exportStar(require("./post-reply"), exports);
 __exportStar(require("./organization"), exports);
 __exportStar(require("./person"), exports);
 __exportStar(require("./profile"), exports);
+__exportStar(require("./statistics"), exports);
 __exportStar(require("./testimonial"), exports);
 __exportStar(require("./time"), exports);
 __exportStar(require("./translation"), exports);

package/dist/types/api/statistics.d.ts

@@ -0,0 +1,45 @@
+import { OptionTitle } from "./common";
+export declare enum StatisticsMetric {
+    NEW_VOLUNTEERS = "new-volunteers",
+    REQUESTS = "requests",
+    LEAD_FROM = "lead-from"
+}
+export declare enum StatisticsGranularity {
+    MONTH = "month",
+    QUARTER = "quarter",
+    YEAR = "year"
+}
+export declare enum StatisticsGroupBy {
+    NONE = "none",
+    DISTRICT = "district",
+    OPPORTUNITY_TYPE = "opportunity-type",
+    VOLUNTEER_TYPE = "volunteer-type",
+    LEAD_FROM = "lead-from"
+}
+export declare const STATISTICS_TOTAL_KEY = "total";
+export declare const STATISTICS_UNKNOWN_KEY = "unknown";
+export interface ApiStatisticsQuery {
+    granularity: StatisticsGranularity;
+    from?: string;
+    to?: string;
+    groupBy?: StatisticsGroupBy;
+}
+export interface ApiStatisticsGroup {
+    key: string;
+    title: OptionTitle;
+}
+export interface ApiStatisticsPeriod {
+    period: string;
+    start: Date;
+    counts: Record<string, number>;
+    total: number;
+}
+export interface ApiStatisticsGet {
+    metric: StatisticsMetric;
+    granularity: StatisticsGranularity;
+    groupBy: StatisticsGroupBy;
+    allowedGroupBy: StatisticsGroupBy[];
+    groups: ApiStatisticsGroup[];
+    periods: ApiStatisticsPeriod[];
+    totalsBeforeTracking?: Record<string, number>;
+}

package/dist/types/api/statistics.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STATISTICS_UNKNOWN_KEY = exports.STATISTICS_TOTAL_KEY = exports.StatisticsGroupBy = exports.StatisticsGranularity = exports.StatisticsMetric = void 0;
+// Periods are Europe/Berlin calendar periods, widened to whole periods.
+var StatisticsMetric;
+(function (StatisticsMetric) {
+    StatisticsMetric["NEW_VOLUNTEERS"] = "new-volunteers";
+    StatisticsMetric["REQUESTS"] = "requests";
+    // Counts ticked answers: one volunteer can tick several.
+    StatisticsMetric["LEAD_FROM"] = "lead-from";
+})(StatisticsMetric || (exports.StatisticsMetric = StatisticsMetric = {}));
+var StatisticsGranularity;
+(function (StatisticsGranularity) {
+    StatisticsGranularity["MONTH"] = "month";
+    StatisticsGranularity["QUARTER"] = "quarter";
+    StatisticsGranularity["YEAR"] = "year";
+})(StatisticsGranularity || (exports.StatisticsGranularity = StatisticsGranularity = {}));
+var StatisticsGroupBy;
+(function (StatisticsGroupBy) {
+    StatisticsGroupBy["NONE"] = "none";
+    StatisticsGroupBy["DISTRICT"] = "district";
+    StatisticsGroupBy["OPPORTUNITY_TYPE"] = "opportunity-type";
+    StatisticsGroupBy["VOLUNTEER_TYPE"] = "volunteer-type";
+    StatisticsGroupBy["LEAD_FROM"] = "lead-from";
+})(StatisticsGroupBy || (exports.StatisticsGroupBy = StatisticsGroupBy = {}));
+exports.STATISTICS_TOTAL_KEY = "total";
+exports.STATISTICS_UNKNOWN_KEY = "unknown";

package/dist/types/api/user.d.ts

@@ -50,6 +50,7 @@ export interface ApiUserVerifyEmail {
     message: string;
     verified: boolean;
     hasVolunteerProfile?: boolean;
+    hasAgentMembership?: boolean;
 }
 export interface ApiCoordinatorInvitePost {
     email: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "need4deed-sdk",
-  "version": "0.0.168",
+  "version": "0.0.170",
   "description": "Need4Deed.org SDK",
   "type": "commonjs",
   "main": "dist/index.js",