randmar-api-client 1.577.0 → 1.579.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -868,7 +868,7 @@ export type GetV4ResellerByRouteResellerIdBillingApiArg = {
868
868
  routeResellerId: string;
869
869
  };
870
870
  export type GetV4ResellerByRouteResellerIdBillingInvoicesApiResponse =
871
- /** status 200 A list of all invoices for the reseller. */ Invoice[];
871
+ /** status 200 Up to 1,000 recent invoice headers; not invoice line items or an exhaustive history. */ Invoice[];
872
872
  export type GetV4ResellerByRouteResellerIdBillingInvoicesApiArg = {
873
873
  /** The target reseller application ID. */
874
874
  routeResellerId: string;
@@ -1448,13 +1448,13 @@ export type PutV4PartnerEmailByNotificationTypeApiArg = {
1448
1448
  sendEmailRequest: SendEmailRequest;
1449
1449
  };
1450
1450
  export type GetV4PartnerByApplicationIdGeneralDocumentAndGeneralDocumentNumberApiResponse =
1451
- /** status 200 The requested order's information. */ GeneralDocument;
1451
+ /** status 200 General Document object; line collections are included only when withSpecification=true. */ GeneralDocument;
1452
1452
  export type GetV4PartnerByApplicationIdGeneralDocumentAndGeneralDocumentNumberApiArg = {
1453
1453
  /** The partner application ID. Admins must pass the target partner ID, not HQ (`2` / `FGDCT3037`). */
1454
1454
  applicationId: string;
1455
- /** The order/document number to retrieve. */
1455
+ /** Exact original OrderNumber from the active General Documents list or a GeneralDocument search result; not a suffixed operational order, invoice number, or PO. */
1456
1456
  generalDocumentNumber: string;
1457
- /** Whether to include detailed product specifications in the response. Defaults to false. */
1457
+ /** Set true to include ActiveOrderDetails, CompletedOrderDetails, and InvoiceHeaders. Defaults to false; not merely a product-specification toggle. */
1458
1458
  withSpecification?: boolean;
1459
1459
  };
1460
1460
  export type PostV4PartnerByApplicationIdGeneralDocumentAndGeneralDocumentNumberShippingAddressApiResponse = unknown;
@@ -1467,7 +1467,7 @@ export type PostV4PartnerByApplicationIdGeneralDocumentAndGeneralDocumentNumberS
1467
1467
  shippingAddress: ShippingAddress;
1468
1468
  };
1469
1469
  export type GetV4PartnerByRouteApplicationIdGeneralDocumentsApiResponse =
1470
- /** status 200 An array of general documents for the reseller. */ RandmarApiControllersV4PartnerGeneralDocumentRead[];
1470
+ /** status 200 Active General Document records available to the partner; an empty array is valid. */ RandmarApiControllersV4PartnerGeneralDocumentRead[];
1471
1471
  export type GetV4PartnerByRouteApplicationIdGeneralDocumentsApiArg = {
1472
1472
  /** The partner application ID. Admins must pass the target partner ID, not HQ (`2` / `FGDCT3037`). */
1473
1473
  routeApplicationId: string;
@@ -2134,13 +2134,13 @@ export type DeleteV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberPart
2134
2134
  randmarSku: string;
2135
2135
  };
2136
2136
  export type GetV4ResellerByRouteResellerIdOrderAndOrderNumberApiResponse =
2137
- /** status 200 The requested order's information. */ GeneralDocumentOld;
2137
+ /** status 200 Legacy GeneralDocumentOld object; prefer Partner GeneralDocument for new read-only integrations. */ GeneralDocumentOld;
2138
2138
  export type GetV4ResellerByRouteResellerIdOrderAndOrderNumberApiArg = {
2139
2139
  /** The target reseller application ID. */
2140
2140
  routeResellerId: string;
2141
- /** The order number to retrieve. */
2141
+ /** Exact original API order header number, not a reseller PO, GUID, invoice number, or suffixed operational order number. */
2142
2142
  orderNumber: string;
2143
- /** Whether to include detailed product specifications in the response. Defaults to true. */
2143
+ /** When true (default), includes the legacy detail and charge collections. False returns headers and logs without those line collections. */
2144
2144
  withSpecification?: boolean;
2145
2145
  };
2146
2146
  export type PutV4ResellerByRouteResellerIdOrderAndOrderNumberCommentApiResponse = unknown;
@@ -2366,7 +2366,7 @@ export type PostV4ResellerByRouteResellerIdOrderAndOrderNumberTermsTermsCodeApiA
2366
2366
  termsCode: string;
2367
2367
  };
2368
2368
  export type GetV4ResellerByRouteResellerIdOrdersApiResponse =
2369
- /** status 200 A list of orders. */ Order[];
2369
+ /** status 200 Operational order headers. Fetch General Document details separately for line items. */ Order[];
2370
2370
  export type GetV4ResellerByRouteResellerIdOrdersApiArg = {
2371
2371
  /** The target reseller application ID. */
2372
2372
  routeResellerId: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "randmar-api-client",
3
- "version": "1.577.0",
3
+ "version": "1.579.0",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",