@twofistedjustice/square-pie/src/lib/invoice_request_delete.js

an easy to use class based chainable interface for the Square API.

const Invoice_RUDCnP = require("./invoice_request_abstract_RUDCP_super");
const {
  query_param_is_query_string,
  query_param_replace_value,
  shazam_is_integer,
} = require("./utilities");
const man =
  "http request to delete an invoice.\n" +
  "Pass the id of the invoice to be deleted as a string argument when you instantiate the class.\n" +
  "There is no option to add it afterwards. The make() method on this class only sets the version to delete.\n" +
  "https://developer.squareup.com/reference/square/invoices-api/delete-invoice";
/**
 * {@link https://developer.squareup.com/reference/square/invoices-api/delete-invoice |  **-------> Link To Square Docs <-------**}
 * @class Invoice_Delete
 * @extends Square_Request
 * @param {string} id The invoice_id of the invoice you want
 * @classdesc
 *
 * http request to delete an invoice.<br>
 * Pass the id of the invoice to be deleted as a string argument when you instantiate the class.<br>
 * There is no option to add it afterwards. The make() method on this class only sets the version to delete.<br>
 * */

class Invoice_Delete extends Invoice_RUDCnP {
  _display_name = "Invoice_Delete";
  _last_verified_square_api_version = "2021-12-15";
  _help = this.display_name + ": " + man;
  constructor(id) {
    super(id);
    this._method = "DELETE";
    this._delivery;
  }

  set delivery(parcel) {
    this._delivery = parcel;
  }

  get delivery() {
    return this._delivery;
  }

  set #endpoint(str) {
    this._endpoint = str;
  }

  set version(int) {
    if (shazam_is_integer(int, this.display_name, "version"))
      this.#query_param_replace("version", int + "");
  }

  #init_query_param_sequence(param, value) {
    let modified_endpoint = this.endpoint;
    // check if endpoint is already formatted as a query string.
    if (!query_param_is_query_string(modified_endpoint)) {
      // if not then append ?param=value and return false
      modified_endpoint += "?" + param + "=" + value;
      this.#endpoint = modified_endpoint;
      return false;
    } else {
      return true;
    }
  }

  #query_param_replace(param, value) {
    if (this.#init_query_param_sequence(param, value)) {
      this.#endpoint = query_param_replace_value(this.endpoint, param, value);
    }
  }

  // MAKER METHODS

  /**
   *  make() method of Invoice_Delete
   *  Make sure to have the Square Docs open in front of you.
   * Sub-Method names are exactly the same as the property names listed
   * in the Square docs. There may be additional methods and/or shortened aliases of other methods.
   *
   * You should read the generated docs as:
   *     method_name(arg) {type} description of arg
   *
   * @typedef {function} Invoice_Delete.make
   * @method
   * @public
   * @memberOf Invoice_Delete
   * @property version(int) {integer} -
   * @example
   *  You must use parentheses with every call to make and with every sub-method. If you have to make a lot
   *  of calls from different lines, it will reduce your tying and improve readability to set make() to a
   *  variable.
   *
   *  let make = myVar.make();
   *   make.gizmo()
   *   make.gremlin()
   *    //is the same as
   *   myVar.make().gizmo().gremlin()
   * */
  make() {
    return {
      self: this,
      version: function (int) {
        this.self.version = int;
        return this;
      },
    };
  }
}

module.exports = Invoice_Delete;