Working hours

Author: KirillSergeevich

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linkedapi/node",
-  "version": "2.3.5",
+  "version": "2.3.6",
   "description": "Control your LinkedIn accounts and retrieve real-time data, all through this Node.js SDK.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/core/operation.ts

@@ -107,6 +107,7 @@ export abstract class Operation<TParams, TResult> {
         workflowId,
         workflowStatus: workflowResult.workflowStatus,
         message: workflowResult.message,
+        pendingReason: workflowResult.pendingReason ?? null,
       };
     }
 

src/types/errors.ts

@@ -79,6 +79,8 @@ export const LINKED_API_ERROR = {
   linkedinAccountSignedOut: 'linkedinAccountSignedOut',
   languageNotSupported: 'languageNotSupported',
   workflowTimeout: 'workflowTimeout',
+  outsideWorkingHours: 'outsideWorkingHours',
+  workingHoursWaitExpired: 'workingHoursWaitExpired',
   httpError: 'httpError',
   tooManyRequests: 'tooManyRequests',
   accountNotFound: 'accountNotFound',

src/types/index.ts

@@ -3,6 +3,7 @@ export * from './errors';
 export * from './params';
 export * from './responses';
 export * from './workflow-in-progress-response.type';
+export * from './workflow-pending-reason.type';
 export * from './workflow-started-response.type';
 export * from './workflows';
 export * from './webhooks';

src/types/workflow-pending-reason.type.ts

@@ -0,0 +1,14 @@
+/**
+ * Why a workflow is still pending rather than running.
+ *
+ * - `queued` — waiting its turn behind other work on the same LinkedIn account.
+ * - `outsideWorkingHours` — the account has working hours configured with the `pending` off-hours
+ *   policy, and the workflow starts automatically once the window reopens.
+ */
+export const LINKED_API_WORKFLOW_PENDING_REASON = {
+  queued: 'queued',
+  outsideWorkingHours: 'outsideWorkingHours',
+} as const;
+
+export type TWorkflowPendingReason =
+  (typeof LINKED_API_WORKFLOW_PENDING_REASON)[keyof typeof LINKED_API_WORKFLOW_PENDING_REASON];

src/types/workflow-started-response.type.ts

@@ -1,7 +1,9 @@
+import { TWorkflowPendingReason } from './workflow-pending-reason.type';
 import { TWorkflowInProgressStatus } from './workflows';
 
 export interface TWorkflowStartedResponse {
   workflowId: string;
   workflowStatus: TWorkflowInProgressStatus;
   message?: string;
+  pendingReason?: TWorkflowPendingReason | null;
 }

src/types/workflows.ts

@@ -1,5 +1,7 @@
 import { TLinkedApiActionError } from '../types/errors';
 
+import { TWorkflowPendingReason } from './workflow-pending-reason.type';
+
 export interface TSingleActionWorkflowDefinition {
   actionType: string;
   [key: string]: unknown;
@@ -42,6 +44,7 @@ export interface TWorkflowStatusResponse {
   workflowId: string;
   workflowStatus: TWorkflowStatus;
   message?: string;
+  pendingReason?: TWorkflowPendingReason | null;
 }
 
 export interface TWorkflowResponse<