@skriptfabrik/n8n-nodes-fulfillmenttools 0.1.0 → 0.1.2

package/src/nodes/Fulfillmenttools/GenericFunctions.ts

@@ -0,0 +1,156 @@
+import type {
+  IDataObject,
+  IExecuteFunctions,
+  IHttpRequestMethods,
+  IHookFunctions,
+  ILoadOptionsFunctions,
+  IPollFunctions,
+  IHttpRequestOptions,
+} from 'n8n-workflow';
+import { NodeApiError, sleep } from 'n8n-workflow';
+
+export async function fulfillmenttoolsApiRequest(
+  this:
+    | IExecuteFunctions
+    | IHookFunctions
+    | ILoadOptionsFunctions
+    | IPollFunctions,
+  method: IHttpRequestMethods,
+  url: string,
+  body?: IDataObject,
+  qs?: IDataObject,
+): Promise<IDataObject> {
+  const credentials = await this.getCredentials('fulfillmenttoolsApi');
+
+  const requestOptions: IHttpRequestOptions = {
+    url,
+    baseURL: `https://${credentials['subDomain']}.api.fulfillmenttools.com/api`,
+    headers: {
+      accept: 'application/json',
+      'content-type': 'application/json',
+    },
+    method,
+    body,
+    qs,
+    returnFullResponse: true,
+    ignoreHttpStatusErrors: true,
+    json: true,
+  };
+
+  let response: {
+    body: IDataObject | IDataObject[];
+    headers: Record<string, string>;
+    statusCode: number;
+    statusMessage: string;
+  };
+
+  const totalRetries = 9;
+
+  let remainingRetries = totalRetries;
+
+  do {
+    response = await this.helpers.httpRequestWithAuthentication.call(
+      this,
+      'fulfillmenttoolsApi',
+      requestOptions,
+    );
+
+    if (response.statusCode === 409) {
+      const body = response.body as IDataObject[];
+
+      if (
+        remainingRetries > 1 &&
+        body.length > 0 &&
+        body[0]['version'] !== undefined
+      ) {
+        requestOptions.body.version = body[0]['version'];
+        remainingRetries = 1;
+      } else {
+        remainingRetries = 0;
+      }
+    } else if (response.statusCode === 429) {
+      await sleep(Math.pow(2, totalRetries - remainingRetries) * 500);
+      remainingRetries = remainingRetries - 1;
+    } else {
+      remainingRetries = 0;
+    }
+  } while (remainingRetries > 0);
+
+  if (response.statusCode === 429) {
+    throw new NodeApiError(
+      this.getNode(),
+      {},
+      {
+        message: response.statusMessage,
+        httpCode: response.statusCode.toString(),
+        description: 'The maximum number of retries has been reached.',
+      },
+    );
+  } else if (response.statusCode >= 400) {
+    throw new NodeApiError(
+      this.getNode(),
+      {},
+      {
+        message: response.statusMessage,
+        httpCode: response.statusCode.toString(),
+        description: (response.body as IDataObject[])
+          .map((error) => error['summary'])
+          .join('\n'),
+      },
+    );
+  }
+
+  return response.body as IDataObject;
+}
+
+export async function fulfillmenttoolsApiRequestAllItems<
+  T extends string | undefined,
+>(
+  this:
+    | IExecuteFunctions
+    | IHookFunctions
+    | ILoadOptionsFunctions
+    | IPollFunctions,
+  resource: T,
+  method: IHttpRequestMethods,
+  url: string,
+  body?: IDataObject,
+  qs: IDataObject = {},
+): Promise<IDataObject[]> {
+  const returnData: (IDataObject & { id?: string })[] = [];
+
+  let responseItems;
+
+  do {
+    const responseData = (await fulfillmenttoolsApiRequest.call(
+      this,
+      method,
+      url,
+      body,
+      qs,
+    )) as T extends string
+      ? { [R: string]: (IDataObject & { id?: string })[] }
+      : (IDataObject & { id?: string })[];
+
+    if (resource === undefined) {
+      responseItems = responseData as (IDataObject & { id?: string })[];
+    } else {
+      responseItems = (
+        responseData as { [R: string]: (IDataObject & { id?: string })[] }
+      )[resource];
+    }
+
+    returnData.push(...responseItems);
+
+    if (
+      qs['limit'] !== undefined &&
+      returnData.length >= (qs['limit'] as number)
+    ) {
+      return returnData.splice(0, qs['limit'] as number);
+    }
+
+    qs['startAfterId'] = returnData[returnData.length - 1].id;
+  } while (responseItems.length > 0);
+
+  return returnData;
+}

package/src/nodes/Fulfillmenttools/descriptions/FacilityCarrierDescription.ts

@@ -0,0 +1,335 @@
+import type { INodeProperties } from 'n8n-workflow';
+
+export const facilityCarrierOperations: INodeProperties[] = [
+  {
+    displayName: 'Operation',
+    name: 'operation',
+    type: 'options',
+    noDataExpression: true,
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+      },
+    },
+    options: [
+      {
+        name: 'Create',
+        value: 'create',
+        description:
+          'Create a connection of a configured carrier to the facility with the given ID',
+        action: 'Create facility carrier',
+      },
+      {
+        name: 'Get',
+        value: 'get',
+        description:
+          'Get the details for a carrier related to the facility with the given ID',
+        action: 'Get facility carrier',
+      },
+      {
+        name: 'List',
+        value: 'list',
+        description: 'Get the available CEPs for a facility',
+        action: 'List facility carriers',
+      },
+      {
+        name: 'Connect',
+        value: 'connect',
+        description:
+          'Connect a configured carrier to the facility with the given ID',
+        action: 'Connect facility carrier',
+      },
+    ],
+    default: 'create',
+  },
+];
+
+export const facilityCarrierFields: INodeProperties[] = [
+  /* -------------------------------------------------------------------------- */
+  /*                           facilityCarrier:create                           */
+  /* -------------------------------------------------------------------------- */
+  {
+    displayName: 'Facility ID',
+    name: 'facilityId',
+    type: 'string',
+    required: true,
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['create'],
+      },
+    },
+    description: 'ID of facility you want to create a connection for',
+  },
+  {
+    displayName: 'Carrier Ref',
+    name: 'carrierRef',
+    type: 'string',
+    required: true,
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['create'],
+      },
+    },
+    description: 'ID of the referenced carrier',
+  },
+  {
+    displayName: 'Locale',
+    name: 'locale',
+    type: 'string',
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['create'],
+      },
+    },
+    description:
+      'Localized names and descriptions for the parcel label classifications',
+  },
+  {
+    displayName: 'Facility Carrier',
+    name: 'facilityCarrier',
+    type: 'json',
+    required: true,
+    default: JSON.stringify(
+      {
+        credentials: {
+          key: 'string',
+          billingNumber: '22222222220101',
+          retoureBillingNumber: '22222222220701',
+          internationalBillingNumber: '22222222220701',
+          dhlBusinessPassword: 'string',
+          dhlBusinessUsername: 'string',
+          dhlBusinessUsergroup: 'string',
+        },
+        configuration: {
+          key: 'string',
+          contactId: 'It-aGZXHEm870vI',
+          returnContactId: '7g0UXSgZMQd08K7',
+        },
+        cutoffTime: {
+          hour: 16,
+          minute: 30,
+        },
+        deliveryAreas: [
+          {
+            country: 'DE',
+            postalCode: '40764',
+          },
+        ],
+        name: 'DHL Köln',
+        status: 'ACTIVE',
+        parcelLabelClassifications: [
+          {
+            nameLocalized: {
+              de_DE: 'Wert',
+              en_US: 'Value',
+              ru_RU: 'значение',
+            },
+            dimensions: {
+              height: 50,
+              length: 100,
+              weight: 1700,
+              width: 25,
+            },
+          },
+        ],
+        tags: [
+          {
+            value: 'string',
+            id: 'string',
+          },
+        ],
+        validDeliveryTargets: ['SHIP_TO_STORE'],
+      },
+      undefined,
+      2,
+    ),
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['create'],
+      },
+    },
+    description: 'Representation that describes the connection',
+  },
+  /* -------------------------------------------------------------------------- */
+  /*                            facilityCarrier:get                             */
+  /* -------------------------------------------------------------------------- */
+  {
+    displayName: 'Facility ID',
+    name: 'facilityId',
+    type: 'string',
+    required: true,
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['get'],
+      },
+    },
+    description: 'ID of facility you want to get',
+  },
+  {
+    displayName: 'Carrier Ref',
+    name: 'carrierRef',
+    type: 'string',
+    required: true,
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['get'],
+      },
+    },
+    description: 'ID of the referenced carrier',
+  },
+  {
+    displayName: 'Locale',
+    name: 'locale',
+    type: 'string',
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['get'],
+      },
+    },
+    description:
+      'Localized names and descriptions for the parcel label classifications',
+  },
+  /* -------------------------------------------------------------------------- */
+  /*                            facilityCarrier:list                            */
+  /* -------------------------------------------------------------------------- */
+  {
+    displayName: 'Facility ID',
+    name: 'facilityId',
+    type: 'string',
+    required: true,
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['list'],
+      },
+    },
+    description: 'ID of facility you want to get',
+  },
+  /* -------------------------------------------------------------------------- */
+  /*                              facilityCarrier:connect                       */
+  /* -------------------------------------------------------------------------- */
+  {
+    displayName: 'Facility ID',
+    name: 'facilityId',
+    type: 'string',
+    required: true,
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['connect'],
+      },
+    },
+    description: 'ID of facility you want to patch',
+  },
+  {
+    displayName: 'Carrier Ref',
+    name: 'carrierRef',
+    type: 'string',
+    required: true,
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['connect'],
+      },
+    },
+    description: 'ID of the referenced carrier',
+  },
+  {
+    displayName: 'Locale',
+    name: 'locale',
+    type: 'string',
+    default: '',
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['connect'],
+      },
+    },
+    description:
+      'Localized names and descriptions for the parcel label classifications',
+  },
+  {
+    displayName: 'Facility',
+    name: 'facilityCarrier',
+    type: 'json',
+    required: true,
+    default: JSON.stringify(
+      {
+        credentials: {
+          key: 'string',
+          billingNumber: '22222222220101',
+          retoureBillingNumber: '22222222220701',
+          internationalBillingNumber: '22222222220701',
+          dhlBusinessPassword: 'string',
+          dhlBusinessUsername: 'string',
+          dhlBusinessUsergroup: 'string',
+        },
+        configuration: {
+          key: 'string',
+          contactId: 'D6C3fImQqpVV1E9',
+          returnContactId: 't1h-EQTdpiXl8J4',
+        },
+        cutoffTime: {
+          hour: 16,
+          minute: 30,
+        },
+        deliveryAreas: [
+          {
+            country: 'DE',
+            postalCode: '40764',
+          },
+        ],
+        name: 'DHL Köln',
+        status: 'ACTIVE',
+        parcelLabelClassifications: [
+          {
+            nameLocalized: {
+              de_DE: 'Wert',
+              en_US: 'Value',
+              ru_RU: 'значение',
+            },
+            dimensions: {
+              height: 50,
+              length: 100,
+              weight: 1700,
+              width: 25,
+            },
+          },
+        ],
+        tags: [
+          {
+            value: 'string',
+            id: 'string',
+          },
+        ],
+        version: 0,
+        validDeliveryTargets: ['SHIP_TO_STORE'],
+      },
+      undefined,
+      2,
+    ),
+    displayOptions: {
+      show: {
+        resource: ['facilityCarrier'],
+        operation: ['connect'],
+      },
+    },
+    description: 'Representation that describes the connection',
+  },
+];