@rippling/rippling-sdk 0.2.0-alpha.100 → 0.2.0-alpha.101

package/resources/packages/packages.js

@@ -29,30 +29,159 @@ class Packages extends resource_1.APIResource {
      * - Requires: `Unity Packages V2 Platform API`
      * - Filterable fields: `package_key`
      * - Sortable fields: `id`, `created_at`, `updated_at`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /packages/?filter=filter&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "__meta": {
+     *     "redacted_fields": [
+     *       {
+     *         "name": "date_of_birth",
+     *         "reason": "Insufficient entitlements"
+     *       }
+     *     ]
+     *   },
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "package_key": "string",
+     *       "package_display_name": "string",
+     *       "description": "string",
+     *       "package_type": "string",
+     *       "latest_version_id": "string",
+     *       "latest_version_number": "string"
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/packages/', (pagination_1.PageCursorURL), { query, ...options });
     }
     /**
      * Create a new package
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /packages/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "package_display_name": "package_display_name",
+     *   "package_key": "package_key",
+     *   "package_type": "package_type"
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "package_key": "string",
+     *   "package_display_name": "string",
+     *   "description": "string",
+     *   "package_type": "string",
+     *   "latest_version_id": "string",
+     *   "latest_version_number": "string"
+     * }
+     * ```
      */
     create(body, options) {
         return this._client.post('/packages/', { body, ...options });
     }
     /**
      * Retrieve a specific package
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /packages/package_key/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "__meta": {
+     *     "redacted_fields": [
+     *       {}
+     *     ]
+     *   }
+     * }
+     * ```
      */
     retrieve(packageKey, options) {
         return this._client.get((0, path_1.path) `/packages/${packageKey}/`, options);
     }
     /**
      * Update a specific package.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * PATCH /packages/package_key/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "package_display_name": "package_display_name",
+     *   "package_key": "package_key",
+     *   "package_type": "package_type"
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "package_key": "string",
+     *   "package_display_name": "string",
+     *   "description": "string",
+     *   "package_type": "string",
+     *   "latest_version_id": "string",
+     *   "latest_version_number": "string"
+     * }
+     * ```
      */
     update(packageKey, body, options) {
         return this._client.patch((0, path_1.path) `/packages/${packageKey}/`, { body, ...options });
     }
     /**
      * Delete a package
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * DELETE /packages/package_key/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 204 No Content
+     * ```
      */
     delete(packageKey, options) {
         return this._client.delete((0, path_1.path) `/packages/${packageKey}/`, {

package/resources/packages/packages.js.map

@@ -1 +1 @@
-{"version":3,"file":"packages.js","sourceRoot":"","sources":["../../src/resources/packages/packages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,sFAA6D;AAC7D,gEAI8B;AAC9B,4EAAmD;AACnD,sDAAmG;AACnG,mEAA0C;AAC1C,4CAOoB;AAEpB,yDAAmE;AACnE,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,sBAAiB,GAA2C,IAAI,oBAAoB,CAAC,iBAAiB,CACpG,IAAI,CAAC,OAAO,CACb,CAAC;QACF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkD9F,CAAC;IAhDC;;;;;;OAMG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,0BAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,GAAG,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,GAAG,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAvDD,4BAuDC;AA4PD,QAAQ,CAAC,iBAAiB,GAAG,sCAAiB,CAAC;AAC/C,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC7B,QAAQ,CAAC,YAAY,GAAG,4BAAY,CAAC"}
+{"version":3,"file":"packages.js","sourceRoot":"","sources":["../../src/resources/packages/packages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,sFAA6D;AAC7D,gEAI8B;AAC9B,4EAAmD;AACnD,sDAAmG;AACnG,mEAA0C;AAC1C,4CAOoB;AAEpB,yDAAmE;AACnE,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,sBAAiB,GAA2C,IAAI,oBAAoB,CAAC,iBAAiB,CACpG,IAAI,CAAC,OAAO,CACb,CAAC;QACF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmL9F,CAAC;IAjLC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,0BAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,GAAG,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,GAAG,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAxLD,4BAwLC;AA4PD,QAAQ,CAAC,iBAAiB,GAAG,sCAAiB,CAAC;AAC/C,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC7B,QAAQ,CAAC,YAAY,GAAG,4BAAY,CAAC"}

package/resources/packages/packages.mjs

@@ -25,30 +25,159 @@ export class Packages extends APIResource {
      * - Requires: `Unity Packages V2 Platform API`
      * - Filterable fields: `package_key`
      * - Sortable fields: `id`, `created_at`, `updated_at`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /packages/?filter=filter&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "__meta": {
+     *     "redacted_fields": [
+     *       {
+     *         "name": "date_of_birth",
+     *         "reason": "Insufficient entitlements"
+     *       }
+     *     ]
+     *   },
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "package_key": "string",
+     *       "package_display_name": "string",
+     *       "description": "string",
+     *       "package_type": "string",
+     *       "latest_version_id": "string",
+     *       "latest_version_number": "string"
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(query = {}, options) {
         return this._client.getAPIList('/packages/', (PageCursorURL), { query, ...options });
     }
     /**
      * Create a new package
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /packages/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "package_display_name": "package_display_name",
+     *   "package_key": "package_key",
+     *   "package_type": "package_type"
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "package_key": "string",
+     *   "package_display_name": "string",
+     *   "description": "string",
+     *   "package_type": "string",
+     *   "latest_version_id": "string",
+     *   "latest_version_number": "string"
+     * }
+     * ```
      */
     create(body, options) {
         return this._client.post('/packages/', { body, ...options });
     }
     /**
      * Retrieve a specific package
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /packages/package_key/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "__meta": {
+     *     "redacted_fields": [
+     *       {}
+     *     ]
+     *   }
+     * }
+     * ```
      */
     retrieve(packageKey, options) {
         return this._client.get(path `/packages/${packageKey}/`, options);
     }
     /**
      * Update a specific package.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * PATCH /packages/package_key/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "package_display_name": "package_display_name",
+     *   "package_key": "package_key",
+     *   "package_type": "package_type"
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "package_key": "string",
+     *   "package_display_name": "string",
+     *   "description": "string",
+     *   "package_type": "string",
+     *   "latest_version_id": "string",
+     *   "latest_version_number": "string"
+     * }
+     * ```
      */
     update(packageKey, body, options) {
         return this._client.patch(path `/packages/${packageKey}/`, { body, ...options });
     }
     /**
      * Delete a package
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * DELETE /packages/package_key/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 204 No Content
+     * ```
      */
     delete(packageKey, options) {
         return this._client.delete(path `/packages/${packageKey}/`, {

package/resources/packages/packages.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"packages.mjs","sourceRoot":"","sources":["../../src/resources/packages/packages.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,oBAAoB,iCAA6B;AAC7D,OAAO,EAGL,iBAAiB,GAClB,iCAA6B;AAC9B,OAAO,KAAK,eAAe,4BAAwB;AACnD,OAAO,EAAsD,YAAY,EAAE,4BAAwB;AACnG,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAML,QAAQ,GACT,uBAAmB;AAEpB,OAAO,EAAE,aAAa,EAAe,kCAA8B;AACnE,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,sBAAiB,GAA2C,IAAI,oBAAoB,CAAC,iBAAiB,CACpG,IAAI,CAAC,OAAO,CACb,CAAC;QACF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAkD9F,CAAC;IAhDC;;;;;;OAMG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,aAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,GAAG,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,UAAU,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,UAAU,GAAG,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA4PD,QAAQ,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AAC/C,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC7B,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC"}
+{"version":3,"file":"packages.mjs","sourceRoot":"","sources":["../../src/resources/packages/packages.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,oBAAoB,iCAA6B;AAC7D,OAAO,EAGL,iBAAiB,GAClB,iCAA6B;AAC9B,OAAO,KAAK,eAAe,4BAAwB;AACnD,OAAO,EAAsD,YAAY,EAAE,4BAAwB;AACnG,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAML,QAAQ,GACT,uBAAmB;AAEpB,OAAO,EAAE,aAAa,EAAe,kCAA8B;AACnE,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,sBAAiB,GAA2C,IAAI,oBAAoB,CAAC,iBAAiB,CACpG,IAAI,CAAC,OAAO,CACb,CAAC;QACF,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmL9F,CAAC;IAjLC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,aAAkC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1G,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CAAC,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,UAAU,GAAG,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,UAAU,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,UAAU,GAAG,EAAE;YACzD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA4PD,QAAQ,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;AAC/C,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC7B,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC"}

package/resources/packages/versions.d.mts

@@ -8,10 +8,74 @@ import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Versions extends APIResource {
     /**
      * List package versions belonging to a package.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /packages/package_key/versions/?limit=50&cursor=cursor HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "package_id": "string",
+     *       "package_key": "string",
+     *       "package_display_name": "string",
+     *       "version_number": "string",
+     *       "description": "string",
+     *       "is_published": false,
+     *       "components": [
+     *         "string"
+     *       ]
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(packageKey: string, query?: VersionListParams | null | undefined, options?: RequestOptions): PagePromise<VersionListResponsesPageCursorURL, VersionListResponse>;
     /**
      * Create a new package version.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /packages/package_key/versions/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "version_number": "version_number"
+     * }
+     *
+     * HTTP/1.1 201 Created
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "package_id": "string",
+     *   "package_key": "string",
+     *   "package_display_name": "string",
+     *   "version_number": "string",
+     *   "description": "string",
+     *   "is_published": false,
+     *   "components": [
+     *     null
+     *   ]
+     * }
+     * ```
      */
     create(packageKey: string, body: VersionCreateParams, options?: RequestOptions): APIPromise<VersionCreateResponse>;
 }

package/resources/packages/versions.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"versions.d.mts","sourceRoot":"","sources":["../../src/resources/packages/versions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,kCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,mBAAmB,CAAC;IAQtE;;OAEG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAGrC;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAEnF,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"versions.d.mts","sourceRoot":"","sources":["../../src/resources/packages/versions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,kCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,mBAAmB,CAAC;IAQtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAGrC;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAEnF,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/packages/versions.d.ts

@@ -8,10 +8,74 @@ import { RequestOptions } from "../../internal/request-options.js";
 export declare class Versions extends APIResource {
     /**
      * List package versions belonging to a package.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /packages/package_key/versions/?limit=50&cursor=cursor HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "package_id": "string",
+     *       "package_key": "string",
+     *       "package_display_name": "string",
+     *       "version_number": "string",
+     *       "description": "string",
+     *       "is_published": false,
+     *       "components": [
+     *         "string"
+     *       ]
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(packageKey: string, query?: VersionListParams | null | undefined, options?: RequestOptions): PagePromise<VersionListResponsesPageCursorURL, VersionListResponse>;
     /**
      * Create a new package version.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /packages/package_key/versions/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "version_number": "version_number"
+     * }
+     *
+     * HTTP/1.1 201 Created
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "package_id": "string",
+     *   "package_key": "string",
+     *   "package_display_name": "string",
+     *   "version_number": "string",
+     *   "description": "string",
+     *   "is_published": false,
+     *   "components": [
+     *     null
+     *   ]
+     * }
+     * ```
      */
     create(packageKey: string, body: VersionCreateParams, options?: RequestOptions): APIPromise<VersionCreateResponse>;
 }

package/resources/packages/versions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../../src/resources/packages/versions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,iCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;OAEG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,mBAAmB,CAAC;IAQtE;;OAEG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAGrC;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAEnF,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../../src/resources/packages/versions.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,iCAA8B;AACnE,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,mBAAmB,CAAC;IAQtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAGrC;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;AAEnF,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/packages/versions.js

@@ -11,12 +11,76 @@ const path_1 = require("../../internal/utils/path.js");
 class Versions extends resource_1.APIResource {
     /**
      * List package versions belonging to a package.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /packages/package_key/versions/?limit=50&cursor=cursor HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "package_id": "string",
+     *       "package_key": "string",
+     *       "package_display_name": "string",
+     *       "version_number": "string",
+     *       "description": "string",
+     *       "is_published": false,
+     *       "components": [
+     *         "string"
+     *       ]
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(packageKey, query = {}, options) {
         return this._client.getAPIList((0, path_1.path) `/packages/${packageKey}/versions/`, (pagination_1.PageCursorURL), { query, ...options });
     }
     /**
      * Create a new package version.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /packages/package_key/versions/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "version_number": "version_number"
+     * }
+     *
+     * HTTP/1.1 201 Created
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "package_id": "string",
+     *   "package_key": "string",
+     *   "package_display_name": "string",
+     *   "version_number": "string",
+     *   "description": "string",
+     *   "is_published": false,
+     *   "components": [
+     *     null
+     *   ]
+     * }
+     * ```
      */
     create(packageKey, body, options) {
         return this._client.post((0, path_1.path) `/packages/${packageKey}/versions/`, { body, ...options });

package/resources/packages/versions.js.map

@@ -1 +1 @@
-{"version":3,"file":"versions.js","sourceRoot":"","sources":["../../src/resources/packages/versions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAmE;AAEnE,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;OAEG;IACH,IAAI,CACF,UAAkB,EAClB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,aAAa,UAAU,YAAY,EACvC,CAAA,0BAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA1BD,4BA0BC"}
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../../src/resources/packages/versions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAmE;AAEnE,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CACF,UAAkB,EAClB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,aAAa,UAAU,YAAY,EACvC,CAAA,0BAAkC,CAAA,EAClC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CACJ,UAAkB,EAClB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,UAAU,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA1FD,4BA0FC"}

package/resources/packages/versions.mjs

@@ -8,12 +8,76 @@ import { path } from "../../internal/utils/path.mjs";
 export class Versions extends APIResource {
     /**
      * List package versions belonging to a package.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /packages/package_key/versions/?limit=50&cursor=cursor HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "results": [
+     *     {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "package_id": "string",
+     *       "package_key": "string",
+     *       "package_display_name": "string",
+     *       "version_number": "string",
+     *       "description": "string",
+     *       "is_published": false,
+     *       "components": [
+     *         "string"
+     *       ]
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(packageKey, query = {}, options) {
         return this._client.getAPIList(path `/packages/${packageKey}/versions/`, (PageCursorURL), { query, ...options });
     }
     /**
      * Create a new package version.
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /packages/package_key/versions/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "version_number": "version_number"
+     * }
+     *
+     * HTTP/1.1 201 Created
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "package_id": "string",
+     *   "package_key": "string",
+     *   "package_display_name": "string",
+     *   "version_number": "string",
+     *   "description": "string",
+     *   "is_published": false,
+     *   "components": [
+     *     null
+     *   ]
+     * }
+     * ```
      */
     create(packageKey, body, options) {
         return this._client.post(path `/packages/${packageKey}/versions/`, { body, ...options });