@greensecurity/javascript-sdk 0.48.0-beta.6 → 0.48.0-beta.8

package/src/models/operations/convertquote.ts

@@ -9,11 +9,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Whether the vendor is sending the converted invoice to their company managers.
+ */
+export type ConvertQuoteRequestBody = {
+  /**
+   * Set to `true` when the vendor is sending the converted invoice to their company managers to pay instead of paying it themselves, and `false` to take it back. Recorded on the invoice as `date_sent_to_company_manager`; the managers are asked to pay once the credential is submitted. Omit the field to leave the invoice as it is. Ignored when no `VendorCredential` is linked to the quote, for an invoice with nothing left to pay, and when the caller is not the vendor. A vendor whose company has no active company manager who sends `true` is refused with `400` and the quote is not converted.
+   */
+  sendToCompanyManager?: boolean | undefined;
+};
+
 export type ConvertQuoteRequest = {
   /**
    * The identifier of the object.
    */
   id: number;
+  /**
+   * Whether the vendor is sending the converted invoice to their company managers.
+   */
+  requestBody?: ConvertQuoteRequestBody | undefined;
 };
 
 /**
@@ -43,9 +57,36 @@ export type ConvertQuoteConvertQuoteOk = {
   total?: number | null | undefined;
 };
 
+/** @internal */
+export type ConvertQuoteRequestBody$Outbound = {
+  send_to_company_manager?: boolean | undefined;
+};
+
+/** @internal */
+export const ConvertQuoteRequestBody$outboundSchema: z.ZodType<
+  ConvertQuoteRequestBody$Outbound,
+  z.ZodTypeDef,
+  ConvertQuoteRequestBody
+> = z.object({
+  sendToCompanyManager: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    sendToCompanyManager: "send_to_company_manager",
+  });
+});
+
+export function convertQuoteRequestBodyToJSON(
+  convertQuoteRequestBody: ConvertQuoteRequestBody,
+): string {
+  return JSON.stringify(
+    ConvertQuoteRequestBody$outboundSchema.parse(convertQuoteRequestBody),
+  );
+}
+
 /** @internal */
 export type ConvertQuoteRequest$Outbound = {
   id: number;
+  RequestBody?: ConvertQuoteRequestBody$Outbound | undefined;
 };
 
 /** @internal */
@@ -55,6 +96,11 @@ export const ConvertQuoteRequest$outboundSchema: z.ZodType<
   ConvertQuoteRequest
 > = z.object({
   id: z.number().int(),
+  requestBody: z.lazy(() => ConvertQuoteRequestBody$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
 });
 
 export function convertQuoteRequestToJSON(

package/src/models/operations/createinvoice.ts

@@ -62,6 +62,10 @@ export type Five = {
    * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
    */
   useCredits?: boolean | undefined;
+  /**
+   * For a `vendor_credential_id` invoice, set to `true` when the vendor is sending the invoice to their company managers to pay instead of paying it themselves. The server records it on the invoice as `date_sent_to_company_manager`, and asks the managers to pay once the credential is submitted. Send it without `credential_pricing_ids` to send an invoice the credential already has. Set to `false` to take the invoice back. Omit the field to leave the invoice as it is. Ignored for a quote, for an invoice with nothing left to pay, and when the caller is not the vendor. A vendor whose company has no active company manager who sends `true` is refused with `400` before anything is created.
+   */
+  sendToCompanyManager?: boolean | undefined;
 };
 
 export const CreateInvoiceRequestBodyInvoicesPaymentHandler = {
@@ -113,6 +117,10 @@ export type Four = {
    * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
    */
   useCredits?: boolean | undefined;
+  /**
+   * For a `vendor_credential_id` invoice, set to `true` when the vendor is sending the invoice to their company managers to pay instead of paying it themselves. The server records it on the invoice as `date_sent_to_company_manager`, and asks the managers to pay once the credential is submitted. Send it without `credential_pricing_ids` to send an invoice the credential already has. Set to `false` to take the invoice back. Omit the field to leave the invoice as it is. Ignored for a quote, for an invoice with nothing left to pay, and when the caller is not the vendor. A vendor whose company has no active company manager who sends `true` is refused with `400` before anything is created.
+   */
+  sendToCompanyManager?: boolean | undefined;
 };
 
 export const CreateInvoiceRequestBodyPaymentHandler = {
@@ -164,6 +172,10 @@ export type Three = {
    * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
    */
   useCredits?: boolean | undefined;
+  /**
+   * For a `vendor_credential_id` invoice, set to `true` when the vendor is sending the invoice to their company managers to pay instead of paying it themselves. The server records it on the invoice as `date_sent_to_company_manager`, and asks the managers to pay once the credential is submitted. Send it without `credential_pricing_ids` to send an invoice the credential already has. Set to `false` to take the invoice back. Omit the field to leave the invoice as it is. Ignored for a quote, for an invoice with nothing left to pay, and when the caller is not the vendor. A vendor whose company has no active company manager who sends `true` is refused with `400` before anything is created.
+   */
+  sendToCompanyManager?: boolean | undefined;
 };
 
 export const RequestBodyPaymentHandler = {
@@ -213,6 +225,10 @@ export type CreateInvoiceRequestBody2 = {
    * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
    */
   useCredits?: boolean | undefined;
+  /**
+   * For a `vendor_credential_id` invoice, set to `true` when the vendor is sending the invoice to their company managers to pay instead of paying it themselves. The server records it on the invoice as `date_sent_to_company_manager`, and asks the managers to pay once the credential is submitted. Send it without `credential_pricing_ids` to send an invoice the credential already has. Set to `false` to take the invoice back. Omit the field to leave the invoice as it is. Ignored for a quote, for an invoice with nothing left to pay, and when the caller is not the vendor. A vendor whose company has no active company manager who sends `true` is refused with `400` before anything is created.
+   */
+  sendToCompanyManager?: boolean | undefined;
 };
 
 export const PaymentHandler = {
@@ -260,6 +276,10 @@ export type RequestBody1 = {
    * Set to `true` when the payer intends to settle this order from their credit balance before their payment method is charged. This affects only how the convenience fee is calculated: the fee pays for card processing, so it is assessed on the amount the card is left to cover once credits have been applied, and an order a balance covers in full carries none. No credits are debited here, and the balance is read from the payer's own ledger rather than taken from this request. Settle the credits with `POST /invoices/{id}/payment` and `use_credits: true`.
    */
   useCredits?: boolean | undefined;
+  /**
+   * For a `vendor_credential_id` invoice, set to `true` when the vendor is sending the invoice to their company managers to pay instead of paying it themselves. The server records it on the invoice as `date_sent_to_company_manager`, and asks the managers to pay once the credential is submitted. Send it without `credential_pricing_ids` to send an invoice the credential already has. Set to `false` to take the invoice back. Omit the field to leave the invoice as it is. Ignored for a quote, for an invoice with nothing left to pay, and when the caller is not the vendor. A vendor whose company has no active company manager who sends `true` is refused with `400` before anything is created.
+   */
+  sendToCompanyManager?: boolean | undefined;
 };
 
 /**
@@ -357,6 +377,7 @@ export type Five$Outbound = {
   invoice_type?: string | undefined;
   promo?: string | undefined;
   use_credits: boolean;
+  send_to_company_manager?: boolean | undefined;
 };
 
 /** @internal */
@@ -372,12 +393,14 @@ export const Five$outboundSchema: z.ZodType<Five$Outbound, z.ZodTypeDef, Five> =
         .optional(),
     promo: z.string().optional(),
     useCredits: z.boolean().default(false),
+    sendToCompanyManager: z.boolean().optional(),
   }).transform((v) => {
     return remap$(v, {
       vendorCredentialId: "vendor_credential_id",
       credentialPricingIds: "credential_pricing_ids",
       invoiceType: "invoice_type",
       useCredits: "use_credits",
+      sendToCompanyManager: "send_to_company_manager",
     });
   });
 
@@ -456,6 +479,7 @@ export type Four$Outbound = {
   invoice_type?: string | undefined;
   promo?: string | undefined;
   use_credits: boolean;
+  send_to_company_manager?: boolean | undefined;
 };
 
 /** @internal */
@@ -470,12 +494,14 @@ export const Four$outboundSchema: z.ZodType<Four$Outbound, z.ZodTypeDef, Four> =
       .optional(),
     promo: z.string().optional(),
     useCredits: z.boolean().default(false),
+    sendToCompanyManager: z.boolean().optional(),
   }).transform((v) => {
     return remap$(v, {
       systemId: "system_id",
       credentialPricingIds: "credential_pricing_ids",
       invoiceType: "invoice_type",
       useCredits: "use_credits",
+      sendToCompanyManager: "send_to_company_manager",
     });
   });
 
@@ -556,6 +582,7 @@ export type Three$Outbound = {
   invoice_type?: string | undefined;
   promo?: string | undefined;
   use_credits: boolean;
+  send_to_company_manager?: boolean | undefined;
 };
 
 /** @internal */
@@ -571,12 +598,14 @@ export const Three$outboundSchema: z.ZodType<
   invoiceType: CreateInvoiceRequestBodyInvoiceType$outboundSchema.optional(),
   promo: z.string().optional(),
   useCredits: z.boolean().default(false),
+  sendToCompanyManager: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     facilityId: "facility_id",
     credentialPricingIds: "credential_pricing_ids",
     invoiceType: "invoice_type",
     useCredits: "use_credits",
+    sendToCompanyManager: "send_to_company_manager",
   });
 });
 
@@ -652,6 +681,7 @@ export type CreateInvoiceRequestBody2$Outbound = {
   invoice_type?: string | undefined;
   promo?: string | undefined;
   use_credits: boolean;
+  send_to_company_manager?: boolean | undefined;
 };
 
 /** @internal */
@@ -666,12 +696,14 @@ export const CreateInvoiceRequestBody2$outboundSchema: z.ZodType<
   invoiceType: RequestBodyInvoiceType$outboundSchema.optional(),
   promo: z.string().optional(),
   useCredits: z.boolean().default(false),
+  sendToCompanyManager: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     companyId: "company_id",
     credentialPricingIds: "credential_pricing_ids",
     invoiceType: "invoice_type",
     useCredits: "use_credits",
+    sendToCompanyManager: "send_to_company_manager",
   });
 });
 
@@ -746,6 +778,7 @@ export type RequestBody1$Outbound = {
   invoice_type?: string | undefined;
   promo?: string | undefined;
   use_credits: boolean;
+  send_to_company_manager?: boolean | undefined;
 };
 
 /** @internal */
@@ -760,12 +793,14 @@ export const RequestBody1$outboundSchema: z.ZodType<
   invoiceType: InvoiceType$outboundSchema.optional(),
   promo: z.string().optional(),
   useCredits: z.boolean().default(false),
+  sendToCompanyManager: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     vendorId: "vendor_id",
     credentialPricingIds: "credential_pricing_ids",
     invoiceType: "invoice_type",
     useCredits: "use_credits",
+    sendToCompanyManager: "send_to_company_manager",
   });
 });
 

package/src/react-query/invoicesConvertQuote.ts

@@ -63,7 +63,10 @@ export type InvoicesConvertQuoteMutationError =
  * invoices; a caller allowed to create the invoice but not to update the
  * linked `VendorCredential` responds `401`.
  *
- * Takes no request body.
+ * Optionally takes `send_to_company_manager`, for a quote linked to a
+ * `VendorCredential`: send `true` when the vendor is sending the
+ * converted invoice to their company managers to pay instead of paying
+ * it themselves. It follows the same rules as on `POST /invoices`.
  *
  * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission—the caller's role and their relationship to the record decide what it returns.
  */

package/src/sdk/invoices.ts

@@ -185,7 +185,10 @@ export class Invoices extends ClientSDK {
    * invoices; a caller allowed to create the invoice but not to update the
    * linked `VendorCredential` responds `401`.
    *
-   * Takes no request body.
+   * Optionally takes `send_to_company_manager`, for a quote linked to a
+   * `VendorCredential`: send `true` when the vendor is sending the
+   * converted invoice to their company managers to pay instead of paying
+   * it themselves. It follows the same rules as on `POST /invoices`.
    *
    * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission—the caller's role and their relationship to the record decide what it returns.
    */