urembo-hub-api
    Preparing search index...
    Index

    Constructors

    Methods

    • Parameters

      Returns Promise<
          {
              autoReleaseAt: Date;
              clientId: string;
              commissionAmount: Decimal;
              commissionRate: Decimal;
              completedAt: Date;
              completionConfirmedAt: Date;
              confirmedAt: Date;
              createdAt: Date;
              currency: string;
              customerEmail: string;
              customerPhone: string;
              disputedAt: Date;
              escrowAmount: Decimal;
              escrowStatus: string;
              id: string;
              manufacturerId: string;
              notes: string;
              paystackReference: string;
              retailerId: string;
              serviceId: string;
              serviceType: string;
              shippingAddress: JsonValue;
              status: order_status;
              statusEnhanced: order_status_enhanced;
              totalAmount: Decimal;
              updatedAt: Date;
              userId: string;
              vendorId: string;
          },
      >

    • Parameters

      • id: string
      • req: any

      Returns Promise<
          {
              autoReleaseAt: Date;
              clientId: string;
              commissionAmount: Decimal;
              commissionRate: Decimal;
              completedAt: Date;
              completionConfirmedAt: Date;
              confirmedAt: Date;
              createdAt: Date;
              currency: string;
              customerEmail: string;
              customerPhone: string;
              disputedAt: Date;
              escrowAmount: Decimal;
              escrowStatus: string;
              id: string;
              manufacturerId: string;
              notes: string;
              paystackReference: string;
              retailerId: string;
              serviceId: string;
              serviceType: string;
              shippingAddress: JsonValue;
              status: order_status;
              statusEnhanced: order_status_enhanced;
              totalAmount: Decimal;
              updatedAt: Date;
              userId: string;
              vendorId: string;
          },
      >

    • Parameters

      • id: string
      • req: any

      Returns Promise<
          {
              autoReleaseAt: Date;
              clientId: string;
              commissionAmount: Decimal;
              commissionRate: Decimal;
              completedAt: Date;
              completionConfirmedAt: Date;
              confirmedAt: Date;
              createdAt: Date;
              currency: string;
              customerEmail: string;
              customerPhone: string;
              disputedAt: Date;
              escrowAmount: Decimal;
              escrowStatus: string;
              id: string;
              manufacturerId: string;
              notes: string;
              paystackReference: string;
              retailerId: string;
              serviceId: string;
              serviceType: string;
              shippingAddress: JsonValue;
              status: order_status;
              statusEnhanced: order_status_enhanced;
              totalAmount: Decimal;
              updatedAt: Date;
              userId: string;
              vendorId: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              orderItems: (
                  {
                      product: {
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                          retailerId: string;
                      };
                  } & {
                      createdAt: Date;
                      currency: string;
                      id: string;
                      orderId: string;
                      productId: string;
                      quantity: number;
                      refId: string;
                      subtotal: Decimal;
                      title: string;
                      totalPrice: Decimal;
                      type: string;
                      unitPrice: Decimal;
                      updatedAt: Date;
                  }
              )[];
              serviceAppointments: (
                  {
                      service: {
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                      };
                      vendor: {
                          businessName: string;
                          email: string;
                          fullName: string;
                          id: string;
                      };
                  } & {
                      appointmentDate: Date;
                      createdAt: Date;
                      currency: string;
                      durationMinutes: number;
                      id: string;
                      notes: string;
                      orderId: string;
                      serviceId: string;
                      servicePrice: Decimal;
                      staffId: string;
                      status: string;
                      updatedAt: Date;
                      vendorId: string;
                  }
              )[];
              shipments: (
                  {
                      statusUpdates: {
                          id: string;
                          location: string;
                          metadata: JsonValue;
                          notes: string;
                          previousStatus: shipment_status;
                          shipmentId: string;
                          status: shipment_status;
                          updatedAt: Date;
                          updatedBy: string;
                      }[];
                  } & {
                      actualDeliveryDate: Date;
                      createdAt: Date;
                      createdBy: string;
                      deliveryAddress: JsonValue;
                      deliveryNotes: string;
                      deliveryPartner: string;
                      estimatedDeliveryDate: Date;
                      id: string;
                      orderId: string;
                      shipmentNumber: string;
                      trackingNumber: string;
                      updatedAt: Date;
                  }
              )[];
              user: { email: string; fullName: string; id: string };
          } & {
              autoReleaseAt: Date;
              clientId: string;
              commissionAmount: Decimal;
              commissionRate: Decimal;
              completedAt: Date;
              completionConfirmedAt: Date;
              confirmedAt: Date;
              createdAt: Date;
              currency: string;
              customerEmail: string;
              customerPhone: string;
              disputedAt: Date;
              escrowAmount: Decimal;
              escrowStatus: string;
              id: string;
              manufacturerId: string;
              notes: string;
              paystackReference: string;
              retailerId: string;
              serviceId: string;
              serviceType: string;
              shippingAddress: JsonValue;
              status: order_status;
              statusEnhanced: order_status_enhanced;
              totalAmount: Decimal;
              updatedAt: Date;
              userId: string;
              vendorId: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              orderItems: (
                  {
                      product: {
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                          retailerId: string;
                      };
                  } & {
                      createdAt: Date;
                      currency: string;
                      id: string;
                      orderId: string;
                      productId: string;
                      quantity: number;
                      refId: string;
                      subtotal: Decimal;
                      title: string;
                      totalPrice: Decimal;
                      type: string;
                      unitPrice: Decimal;
                      updatedAt: Date;
                  }
              )[];
              serviceAppointments: (
                  {
                      service: {
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                      };
                      vendor: {
                          businessName: string;
                          email: string;
                          fullName: string;
                          id: string;
                      };
                  } & {
                      appointmentDate: Date;
                      createdAt: Date;
                      currency: string;
                      durationMinutes: number;
                      id: string;
                      notes: string;
                      orderId: string;
                      serviceId: string;
                      servicePrice: Decimal;
                      staffId: string;
                      status: string;
                      updatedAt: Date;
                      vendorId: string;
                  }
              )[];
              shipments: (
                  {
                      statusUpdates: {
                          id: string;
                          location: string;
                          metadata: JsonValue;
                          notes: string;
                          previousStatus: shipment_status;
                          shipmentId: string;
                          status: shipment_status;
                          updatedAt: Date;
                          updatedBy: string;
                      }[];
                  } & {
                      actualDeliveryDate: Date;
                      createdAt: Date;
                      createdBy: string;
                      deliveryAddress: JsonValue;
                      deliveryNotes: string;
                      deliveryPartner: string;
                      estimatedDeliveryDate: Date;
                      id: string;
                      orderId: string;
                      shipmentNumber: string;
                      trackingNumber: string;
                      updatedAt: Date;
                  }
              )[];
              user: { email: string; fullName: string; id: string };
          } & {
              autoReleaseAt: Date;
              clientId: string;
              commissionAmount: Decimal;
              commissionRate: Decimal;
              completedAt: Date;
              completionConfirmedAt: Date;
              confirmedAt: Date;
              createdAt: Date;
              currency: string;
              customerEmail: string;
              customerPhone: string;
              disputedAt: Date;
              escrowAmount: Decimal;
              escrowStatus: string;
              id: string;
              manufacturerId: string;
              notes: string;
              paystackReference: string;
              retailerId: string;
              serviceId: string;
              serviceType: string;
              shippingAddress: JsonValue;
              status: order_status;
              statusEnhanced: order_status_enhanced;
              totalAmount: Decimal;
              updatedAt: Date;
              userId: string;
              vendorId: string;
          },
      >

    • Parameters

      Returns Promise<
          {
              autoReleaseAt: Date;
              clientId: string;
              commissionAmount: Decimal;
              commissionRate: Decimal;
              completedAt: Date;
              completionConfirmedAt: Date;
              confirmedAt: Date;
              createdAt: Date;
              currency: string;
              customerEmail: string;
              customerPhone: string;
              disputedAt: Date;
              escrowAmount: Decimal;
              escrowStatus: string;
              id: string;
              manufacturerId: string;
              notes: string;
              paystackReference: string;
              retailerId: string;
              serviceId: string;
              serviceType: string;
              shippingAddress: JsonValue;
              status: order_status;
              statusEnhanced: order_status_enhanced;
              totalAmount: Decimal;
              updatedAt: Date;
              userId: string;
              vendorId: string;
          },
      >

    • Parameters

      • Optionalstatus: string

      Returns Promise<
          (
              {
                  orderItems: (
                      {
                          product: {
                              id: string;
                              name: string;
                              price: Decimal;
                              retailerId: string;
                          };
                      } & {
                          createdAt: Date;
                          currency: string;
                          id: string;
                          orderId: string;
                          productId: string;
                          quantity: number;
                          refId: string;
                          subtotal: Decimal;
                          title: string;
                          totalPrice: Decimal;
                          type: string;
                          unitPrice: Decimal;
                          updatedAt: Date;
                      }
                  )[];
                  serviceAppointments: (
                      {
                          service: { id: string; name: string; price: Decimal };
                          vendor: {
                              businessName: string;
                              email: string;
                              fullName: string;
                              id: string;
                          };
                      } & {
                          appointmentDate: Date;
                          createdAt: Date;
                          currency: string;
                          durationMinutes: number;
                          id: string;
                          notes: string;
                          orderId: string;
                          serviceId: string;
                          servicePrice: Decimal;
                          staffId: string;
                          status: string;
                          updatedAt: Date;
                          vendorId: string;
                      }
                  )[];
                  user: { email: string; fullName: string; id: string };
              } & {
                  autoReleaseAt: Date;
                  clientId: string;
                  commissionAmount: Decimal;
                  commissionRate: Decimal;
                  completedAt: Date;
                  completionConfirmedAt: Date;
                  confirmedAt: Date;
                  createdAt: Date;
                  currency: string;
                  customerEmail: string;
                  customerPhone: string;
                  disputedAt: Date;
                  escrowAmount: Decimal;
                  escrowStatus: string;
                  id: string;
                  manufacturerId: string;
                  notes: string;
                  paystackReference: string;
                  retailerId: string;
                  serviceId: string;
                  serviceType: string;
                  shippingAddress: JsonValue;
                  status: order_status;
                  statusEnhanced: order_status_enhanced;
                  totalAmount: Decimal;
                  updatedAt: Date;
                  userId: string;
                  vendorId: string;
              }
          )[],
      >

    • Parameters

      • id: string

      Returns Promise<
          {
              orderItems: (
                  {
                      product: {
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                          retailerId: string;
                      };
                  } & {
                      createdAt: Date;
                      currency: string;
                      id: string;
                      orderId: string;
                      productId: string;
                      quantity: number;
                      refId: string;
                      subtotal: Decimal;
                      title: string;
                      totalPrice: Decimal;
                      type: string;
                      unitPrice: Decimal;
                      updatedAt: Date;
                  }
              )[];
              serviceAppointments: (
                  {
                      service: {
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                      };
                      vendor: {
                          businessName: string;
                          email: string;
                          fullName: string;
                          id: string;
                      };
                  } & {
                      appointmentDate: Date;
                      createdAt: Date;
                      currency: string;
                      durationMinutes: number;
                      id: string;
                      notes: string;
                      orderId: string;
                      serviceId: string;
                      servicePrice: Decimal;
                      staffId: string;
                      status: string;
                      updatedAt: Date;
                      vendorId: string;
                  }
              )[];
              shipments: (
                  {
                      statusUpdates: {
                          id: string;
                          location: string;
                          metadata: JsonValue;
                          notes: string;
                          previousStatus: shipment_status;
                          shipmentId: string;
                          status: shipment_status;
                          updatedAt: Date;
                          updatedBy: string;
                      }[];
                  } & {
                      actualDeliveryDate: Date;
                      createdAt: Date;
                      createdBy: string;
                      deliveryAddress: JsonValue;
                      deliveryNotes: string;
                      deliveryPartner: string;
                      estimatedDeliveryDate: Date;
                      id: string;
                      orderId: string;
                      shipmentNumber: string;
                      trackingNumber: string;
                      updatedAt: Date;
                  }
              )[];
              user: { email: string; fullName: string; id: string };
          } & {
              autoReleaseAt: Date;
              clientId: string;
              commissionAmount: Decimal;
              commissionRate: Decimal;
              completedAt: Date;
              completionConfirmedAt: Date;
              confirmedAt: Date;
              createdAt: Date;
              currency: string;
              customerEmail: string;
              customerPhone: string;
              disputedAt: Date;
              escrowAmount: Decimal;
              escrowStatus: string;
              id: string;
              manufacturerId: string;
              notes: string;
              paystackReference: string;
              retailerId: string;
              serviceId: string;
              serviceType: string;
              shippingAddress: JsonValue;
              status: order_status;
              statusEnhanced: order_status_enhanced;
              totalAmount: Decimal;
              updatedAt: Date;
              userId: string;
              vendorId: string;
          },
      >

    • Parameters

      • retailerId: string

      Returns Promise<
          (
              {
                  order: { clientId: string; createdAt: Date };
                  product: { id: string; name: string; price: Decimal };
              } & {
                  createdAt: Date;
                  currency: string;
                  id: string;
                  orderId: string;
                  productId: string;
                  quantity: number;
                  refId: string;
                  subtotal: Decimal;
                  title: string;
                  totalPrice: Decimal;
                  type: string;
                  unitPrice: Decimal;
                  updatedAt: Date;
              }
          )[],
      >

    • Parameters

      • status: order_status

      Returns Promise<
          (
              {
                  orderItems: (
                      { product: { id: string; name: string; price: Decimal } } & {
                          createdAt: Date;
                          currency: string;
                          id: string;
                          orderId: string;
                          productId: string;
                          quantity: number;
                          refId: string;
                          subtotal: Decimal;
                          title: string;
                          totalPrice: Decimal;
                          type: string;
                          unitPrice: Decimal;
                          updatedAt: Date;
                      }
                  )[];
                  user: { email: string; fullName: string; id: string };
              } & {
                  autoReleaseAt: Date;
                  clientId: string;
                  commissionAmount: Decimal;
                  commissionRate: Decimal;
                  completedAt: Date;
                  completionConfirmedAt: Date;
                  confirmedAt: Date;
                  createdAt: Date;
                  currency: string;
                  customerEmail: string;
                  customerPhone: string;
                  disputedAt: Date;
                  escrowAmount: Decimal;
                  escrowStatus: string;
                  id: string;
                  manufacturerId: string;
                  notes: string;
                  paystackReference: string;
                  retailerId: string;
                  serviceId: string;
                  serviceType: string;
                  shippingAddress: JsonValue;
                  status: order_status;
                  statusEnhanced: order_status_enhanced;
                  totalAmount: Decimal;
                  updatedAt: Date;
                  userId: string;
                  vendorId: string;
              }
          )[],
      >

    • Parameters

      • userId: string
      • req: any

      Returns Promise<
          (
              {
                  orderItems: (
                      { product: { id: string; name: string; price: Decimal } } & {
                          createdAt: Date;
                          currency: string;
                          id: string;
                          orderId: string;
                          productId: string;
                          quantity: number;
                          refId: string;
                          subtotal: Decimal;
                          title: string;
                          totalPrice: Decimal;
                          type: string;
                          unitPrice: Decimal;
                          updatedAt: Date;
                      }
                  )[];
                  user: { email: string; fullName: string; id: string };
              } & {
                  autoReleaseAt: Date;
                  clientId: string;
                  commissionAmount: Decimal;
                  commissionRate: Decimal;
                  completedAt: Date;
                  completionConfirmedAt: Date;
                  confirmedAt: Date;
                  createdAt: Date;
                  currency: string;
                  customerEmail: string;
                  customerPhone: string;
                  disputedAt: Date;
                  escrowAmount: Decimal;
                  escrowStatus: string;
                  id: string;
                  manufacturerId: string;
                  notes: string;
                  paystackReference: string;
                  retailerId: string;
                  serviceId: string;
                  serviceType: string;
                  shippingAddress: JsonValue;
                  status: order_status;
                  statusEnhanced: order_status_enhanced;
                  totalAmount: Decimal;
                  updatedAt: Date;
                  userId: string;
                  vendorId: string;
              }
          )[],
      >

    • Parameters

      • vendorId: string
      • Optionalstatus: string
      • OptionaldateRange: string

      Returns Promise<
          (
              {
                  order: {
                      clientId: string;
                      createdAt: Date;
                      customerEmail: string;
                      id: string;
                      status: order_status;
                      user: { email: string; fullName: string; id: string };
                      userId: string;
                  };
                  service: { id: string; imageUrl: string; name: string; price: Decimal };
                  vendor: {
                      businessName: string;
                      email: string;
                      fullName: string;
                      id: string;
                  };
              } & {
                  appointmentDate: Date;
                  createdAt: Date;
                  currency: string;
                  durationMinutes: number;
                  id: string;
                  notes: string;
                  orderId: string;
                  serviceId: string;
                  servicePrice: Decimal;
                  staffId: string;
                  status: string;
                  updatedAt: Date;
                  vendorId: string;
              }
          )[],
      >

    • Parameters

      • req: any

      Returns Promise<
          (
              {
                  orderItems: (
                      {
                          product: {
                              id: string;
                              imageUrl: string;
                              name: string;
                              price: Decimal;
                          };
                      } & {
                          createdAt: Date;
                          currency: string;
                          id: string;
                          orderId: string;
                          productId: string;
                          quantity: number;
                          refId: string;
                          subtotal: Decimal;
                          title: string;
                          totalPrice: Decimal;
                          type: string;
                          unitPrice: Decimal;
                          updatedAt: Date;
                      }
                  )[];
                  serviceAppointments: (
                      {
                          service: {
                              id: string;
                              imageUrl: string;
                              name: string;
                              price: Decimal;
                          };
                          vendor: {
                              businessName: string;
                              email: string;
                              fullName: string;
                              id: string;
                          };
                      } & {
                          appointmentDate: Date;
                          createdAt: Date;
                          currency: string;
                          durationMinutes: number;
                          id: string;
                          notes: string;
                          orderId: string;
                          serviceId: string;
                          servicePrice: Decimal;
                          staffId: string;
                          status: string;
                          updatedAt: Date;
                          vendorId: string;
                      }
                  )[];
              } & {
                  autoReleaseAt: Date;
                  clientId: string;
                  commissionAmount: Decimal;
                  commissionRate: Decimal;
                  completedAt: Date;
                  completionConfirmedAt: Date;
                  confirmedAt: Date;
                  createdAt: Date;
                  currency: string;
                  customerEmail: string;
                  customerPhone: string;
                  disputedAt: Date;
                  escrowAmount: Decimal;
                  escrowStatus: string;
                  id: string;
                  manufacturerId: string;
                  notes: string;
                  paystackReference: string;
                  retailerId: string;
                  serviceId: string;
                  serviceType: string;
                  shippingAddress: JsonValue;
                  status: order_status;
                  statusEnhanced: order_status_enhanced;
                  totalAmount: Decimal;
                  updatedAt: Date;
                  userId: string;
                  vendorId: string;
              }
          )[],
      >

    • Parameters

      Returns Promise<
          {
              orderItems: (
                  { product: { id: string; name: string; price: Decimal } } & {
                      createdAt: Date;
                      currency: string;
                      id: string;
                      orderId: string;
                      productId: string;
                      quantity: number;
                      refId: string;
                      subtotal: Decimal;
                      title: string;
                      totalPrice: Decimal;
                      type: string;
                      unitPrice: Decimal;
                      updatedAt: Date;
                  }
              )[];
              serviceAppointments: (
                  {
                      service: { id: string; name: string; price: Decimal };
                      vendor: {
                          businessName: string;
                          email: string;
                          fullName: string;
                          id: string;
                      };
                  } & {
                      appointmentDate: Date;
                      createdAt: Date;
                      currency: string;
                      durationMinutes: number;
                      id: string;
                      notes: string;
                      orderId: string;
                      serviceId: string;
                      servicePrice: Decimal;
                      staffId: string;
                      status: string;
                      updatedAt: Date;
                      vendorId: string;
                  }
              )[];
              user: { email: string; fullName: string; id: string };
          } & {
              autoReleaseAt: Date;
              clientId: string;
              commissionAmount: Decimal;
              commissionRate: Decimal;
              completedAt: Date;
              completionConfirmedAt: Date;
              confirmedAt: Date;
              createdAt: Date;
              currency: string;
              customerEmail: string;
              customerPhone: string;
              disputedAt: Date;
              escrowAmount: Decimal;
              escrowStatus: string;
              id: string;
              manufacturerId: string;
              notes: string;
              paystackReference: string;
              retailerId: string;
              serviceId: string;
              serviceType: string;
              shippingAddress: JsonValue;
              status: order_status;
              statusEnhanced: order_status_enhanced;
              totalAmount: Decimal;
              updatedAt: Date;
              userId: string;
              vendorId: string;
          },
      >

    • Parameters

      • id: string
      • req: any
      • body: { notes?: string; status: string }

      Returns Promise<
          {
              order: { user: { email: string; fullName: string; id: string } } & {
                  autoReleaseAt: Date;
                  clientId: string;
                  commissionAmount: Decimal;
                  commissionRate: Decimal;
                  completedAt: Date;
                  completionConfirmedAt: Date;
                  confirmedAt: Date;
                  createdAt: Date;
                  currency: string;
                  customerEmail: string;
                  customerPhone: string;
                  disputedAt: Date;
                  escrowAmount: Decimal;
                  escrowStatus: string;
                  id: string;
                  manufacturerId: string;
                  notes: string;
                  paystackReference: string;
                  retailerId: string;
                  serviceId: string;
                  serviceType: string;
                  shippingAddress: JsonValue;
                  status: order_status;
                  statusEnhanced: order_status_enhanced;
                  totalAmount: Decimal;
                  updatedAt: Date;
                  userId: string;
                  vendorId: string;
              };
              service: { id: string; name: string; price: Decimal };
              vendor: {
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
              };
          } & {
              appointmentDate: Date;
              createdAt: Date;
              currency: string;
              durationMinutes: number;
              id: string;
              notes: string;
              orderId: string;
              serviceId: string;
              servicePrice: Decimal;
              staffId: string;
              status: string;
              updatedAt: Date;
              vendorId: string;
          },
      >