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

package/src/resources/sites.ts

@@ -17,13 +17,51 @@ export class Sites extends APIResource {
    * name filters by case-insensitive substring on display name. Use GET
    * /sites/{api_name}/ for an exact api_name lookup.
    *
-   * @example
+   * @example SDK usage
    * ```ts
    * // Automatically fetches more pages as needed.
    * for await (const siteListResponse of client.sites.list()) {
    *   // ...
    * }
    * ```
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /sites/?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",
+   *       "name": "string",
+   *       "description": "string",
+   *       "api_name": "string",
+   *       "logo": "string",
+   *       "current_bundle_id": "string",
+   *       "admin_group_id": "string",
+   *       "viewer_group_id": "string",
+   *       "created_by": "string",
+   *       "created_at": "string"
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     query: SiteListParams | null | undefined = {},
@@ -35,7 +73,7 @@ export class Sites extends APIResource {
   /**
    * Create a new site from a staged upload.
    *
-   * @example
+   * @example SDK usage
    * ```ts
    * const site = await client.sites.create({
    *   api_name: 'my_portal',
@@ -44,6 +82,39 @@ export class Sites extends APIResource {
    *   entry_path: 'index.html',
    * });
    * ```
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /sites/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "api_name": "my_portal",
+   *   "file_id": "file_id_1",
+   *   "name": "My Portal",
+   *   "entry_path": "index.html"
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "string",
+   *   "name": "string",
+   *   "description": "string",
+   *   "api_name": "string",
+   *   "logo": "string",
+   *   "current_bundle_id": "string",
+   *   "admin_group_id": "string",
+   *   "viewer_group_id": "string",
+   *   "created_by": "string",
+   *   "created_at": "string"
+   * }
+   * ```
    */
   create(body: SiteCreateParams, options?: RequestOptions): APIPromise<SiteCreateResponse> {
     return this._client.post('/sites/', { body, ...options });
@@ -52,10 +123,30 @@ export class Sites extends APIResource {
   /**
    * Retrieve a specific site.
    *
-   * @example
+   * @example SDK usage
    * ```ts
    * const site = await client.sites.retrieve('employee_portal');
    * ```
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /sites/employee_portal/ 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(apiName: string, options?: RequestOptions): APIPromise<SiteRetrieveResponse> {
     return this._client.get(path`/sites/${apiName}/`, options);
@@ -65,7 +156,7 @@ export class Sites extends APIResource {
    * Update a site. To replace the bundle, pass a file_id from
    * upload-batches/presign.
    *
-   * @example
+   * @example SDK usage
    * ```ts
    * const site = await client.sites.update('employee_portal', {
    *   entry_path: 'index.html',
@@ -73,6 +164,38 @@ export class Sites extends APIResource {
    *   name: 'My Portal',
    * });
    * ```
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * PATCH /sites/employee_portal/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "entry_path": "index.html",
+   *   "file_id": "file_id_1",
+   *   "name": "My Portal"
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "string",
+   *   "name": "string",
+   *   "description": "string",
+   *   "api_name": "string",
+   *   "logo": "string",
+   *   "current_bundle_id": "string",
+   *   "admin_group_id": "string",
+   *   "viewer_group_id": "string",
+   *   "created_by": "string",
+   *   "created_at": "string"
+   * }
+   * ```
    */
   update(
     apiName: string,
@@ -85,10 +208,20 @@ export class Sites extends APIResource {
   /**
    * Delete a site.
    *
-   * @example
+   * @example SDK usage
    * ```ts
    * await client.sites.delete('employee_portal');
    * ```
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * DELETE /sites/employee_portal/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 204 No Content
+   * ```
    */
   delete(apiName: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/sites/${apiName}/`, {
@@ -100,7 +233,7 @@ export class Sites extends APIResource {
   /**
    * Create staged upload records and return presigned S3 POST credentials.
    *
-   * @example
+   * @example SDK usage
    * ```ts
    * const response = await client.sites.uploadBatchesPresign({
    *   file_intents: [
@@ -108,6 +241,46 @@ export class Sites extends APIResource {
    *   ],
    * });
    * ```
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /sites/upload-batches/presign/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "file_intents": [
+   *     {
+   *       "client_ref": "index",
+   *       "file_name": "index.html"
+   *     }
+   *   ]
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "upload_batch_id": "batch_id",
+   *   "files": [
+   *     {
+   *       "client_ref": "index",
+   *       "file_id": "file_id_1",
+   *       "file_name": "index.html",
+   *       "status": "awaiting_upload",
+   *       "upload_url": "https://s3.example.com/bucket",
+   *       "upload_fields": {
+   *         "key": "staged/...",
+   *         "policy": "...",
+   *         "x-amz-signature": "..."
+   *       }
+   *     }
+   *   ]
+   * }
+   * ```
    */
   uploadBatchesPresign(
     body: SiteUploadBatchesPresignParams,
@@ -119,12 +292,48 @@ export class Sites extends APIResource {
   /**
    * List files and persisted directories from the active bundle manifest.
    *
-   * @example
+   * @example SDK usage
    * ```ts
    * const response = await client.sites.files(
    *   'employee_portal',
    * );
    * ```
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /sites/employee_portal/files/?parent_path=parent_path&recursive=true 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
+   *
+   * {
+   *   "bundle_id": "bundle_id",
+   *   "entry_path": "index.html",
+   *   "parent_path": "assets",
+   *   "recursive": false,
+   *   "files": [
+   *     {
+   *       "path": "assets/logo.png",
+   *       "name": "logo.png",
+   *       "parent_path": "assets",
+   *       "content_type": "image/png",
+   *       "size_bytes": 12034,
+   *       "sha256": "abc123"
+   *     }
+   *   ],
+   *   "directories": [
+   *     {
+   *       "path": "assets/images",
+   *       "name": "images",
+   *       "parent_path": "assets"
+   *     }
+   *   ]
+   * }
+   * ```
    */
   files(
     apiName: string,
@@ -137,7 +346,7 @@ export class Sites extends APIResource {
   /**
    * Apply file and directory operations atomically against the active bundle.
    *
-   * @example
+   * @example SDK usage
    * ```ts
    * const response = await client.sites.fileOperations('employee_portal', {
    *   base_bundle_id: 'bundle_id',
@@ -168,6 +377,60 @@ export class Sites extends APIResource {
    *   entry_path: 'index.html',
    * });
    * ```
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /sites/employee_portal/file-operations/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "base_bundle_id": "bundle_id",
+   *   "operations": [
+   *     {
+   *       "op": "put",
+   *       "kind": "file",
+   *       "path": "assets/logo.png",
+   *       "file_id": "file_id_1"
+   *     },
+   *     {
+   *       "op": "put",
+   *       "kind": "directory",
+   *       "path": "assets/images"
+   *     },
+   *     {
+   *       "op": "rename",
+   *       "kind": "file",
+   *       "from_path": "home.html",
+   *       "to_path": "index.html"
+   *     },
+   *     {
+   *       "op": "delete",
+   *       "kind": "file",
+   *       "path": "old.js"
+   *     }
+   *   ],
+   *   "entry_path": "index.html"
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "surface_id",
+   *   "name": "Employee Portal",
+   *   "api_name": "employee_portal",
+   *   "logo": "https://example.com/logo.png",
+   *   "current_bundle_id": "new_bundle_id",
+   *   "admin_group_id": "group_id",
+   *   "viewer_group_id": "group_id",
+   *   "created_by": "role_id",
+   *   "created_at": "2024-08-01T12:00:00+00:00"
+   * }
+   * ```
    */
   fileOperations(
     apiName: string,

package/src/resources/software-deployments.ts

@@ -19,6 +19,54 @@ export class SoftwareDeployments extends APIResource {
    * - Filterable fields: `software_id`, `active_group_type`
    * - Expandable fields: `software`
    * - Sortable fields: `id`, `created_at`, `updated_at`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /software-deployments/?filter=filter&expand=expand&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",
+   *       "software_id": "string",
+   *       "software": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "name": "string",
+   *         "display_name": "string",
+   *         "icon_url": "string",
+   *         "description": "string",
+   *         "category": "string",
+   *         "scope": "string",
+   *         "available_platforms": []
+   *       },
+   *       "ma_device_group_id": "string",
+   *       "group_id": "string",
+   *       "active_group_type": "Role",
+   *       "is_report_syncing_in_progress": false
+   *     }
+   *   ],
+   *   "next_link": "string"
+   * }
+   * ```
    */
   list(
     query: SoftwareDeploymentListParams | null | undefined = {},
@@ -32,6 +80,48 @@ export class SoftwareDeployments extends APIResource {
 
   /**
    * Create a new software deployment
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * POST /software-deployments/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "software_id": "software_id"
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "string",
+   *   "created_at": "string",
+   *   "updated_at": "string",
+   *   "software_id": "string",
+   *   "software": {
+   *     "id": "string",
+   *     "created_at": "string",
+   *     "updated_at": "string",
+   *     "name": "string",
+   *     "display_name": "string",
+   *     "icon_url": "string",
+   *     "description": "string",
+   *     "category": "string",
+   *     "scope": "string",
+   *     "available_platforms": [
+   *       "string"
+   *     ]
+   *   },
+   *   "ma_device_group_id": "string",
+   *   "group_id": "string",
+   *   "active_group_type": "Role",
+   *   "is_report_syncing_in_progress": false
+   * }
+   * ```
    */
   create(
     body: SoftwareDeploymentCreateParams,
@@ -42,6 +132,26 @@ export class SoftwareDeployments extends APIResource {
 
   /**
    * Retrieve a specific software deployment
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /software-deployments/id/?expand=expand 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(
     id: string,
@@ -53,6 +163,48 @@ export class SoftwareDeployments extends APIResource {
 
   /**
    * Update a specific software deployment.
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * PATCH /software-deployments/id/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Content-Type: application/json
+   * Accept: application/json
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * {
+   *   "software_id": "software_id"
+   * }
+   *
+   * HTTP/1.1 200 OK
+   * Content-Type: application/json
+   *
+   * {
+   *   "id": "string",
+   *   "created_at": "string",
+   *   "updated_at": "string",
+   *   "software_id": "string",
+   *   "software": {
+   *     "id": "string",
+   *     "created_at": "string",
+   *     "updated_at": "string",
+   *     "name": "string",
+   *     "display_name": "string",
+   *     "icon_url": "string",
+   *     "description": "string",
+   *     "category": "string",
+   *     "scope": "string",
+   *     "available_platforms": [
+   *       "string"
+   *     ]
+   *   },
+   *   "ma_device_group_id": "string",
+   *   "group_id": "string",
+   *   "active_group_type": "Role",
+   *   "is_report_syncing_in_progress": false
+   * }
+   * ```
    */
   update(
     id: string,
@@ -64,6 +216,16 @@ export class SoftwareDeployments extends APIResource {
 
   /**
    * Delete a software deployment
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * DELETE /software-deployments/id/ HTTP/1.1
+   * Host: rest.ripplingapis.com
+   * Rippling-Api-Version: 2024-08-01
+   *
+   * HTTP/1.1 204 No Content
+   * ```
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/software-deployments/${id}/`, {

package/src/resources/sso-me.ts

@@ -14,6 +14,117 @@ export class SSOMeResource extends APIResource {
    *
    * - Requires: `API Tier 1`
    * - Expandable fields: `company`
+   *
+   * @example HTTP
+   * Representative request and response shapes.
+   * ```
+   * GET /sso-me/?expand=expand&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
+   *
+   * {
+   *   "id": "string",
+   *   "created_at": "string",
+   *   "updated_at": "string",
+   *   "work_email": "string",
+   *   "company_id": "string",
+   *   "company": {
+   *     "id": "string",
+   *     "created_at": "string",
+   *     "updated_at": "string",
+   *     "parent_legal_entity_id": "string",
+   *     "parent_legal_entity": {
+   *       "id": "string",
+   *       "created_at": "string",
+   *       "updated_at": "string",
+   *       "tax_identifier": "string",
+   *       "country": {
+   *         "code": "AF"
+   *       },
+   *       "legal_name": "string",
+   *       "entity_level": "PARENT",
+   *       "registration_date": "string",
+   *       "mailing_address": {
+   *         "type": "HOME",
+   *         "formatted": "string",
+   *         "street_address": "string",
+   *         "locality": "string",
+   *         "region": "string",
+   *         "postal_code": "string",
+   *         "country": "AF"
+   *       },
+   *       "physical_address": {
+   *         "type": "HOME",
+   *         "formatted": "string",
+   *         "street_address": "string",
+   *         "locality": "string",
+   *         "region": "string",
+   *         "postal_code": "string",
+   *         "country": "AF"
+   *       },
+   *       "parent_id": "string",
+   *       "parent": {},
+   *       "management_type": "PEO",
+   *       "company_id": "string",
+   *       "company": {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "parent_legal_entity_id": "string",
+   *         "parent_legal_entity": {},
+   *         "legal_entities_id": [],
+   *         "legal_entities": [],
+   *         "physical_address": {},
+   *         "primary_email": "string",
+   *         "legal_name": "string",
+   *         "doing_business_as_name": "string",
+   *         "phone": "string",
+   *         "name": "string"
+   *       }
+   *     },
+   *     "legal_entities_id": [
+   *       "string"
+   *     ],
+   *     "legal_entities": [
+   *       {
+   *         "id": "string",
+   *         "created_at": "string",
+   *         "updated_at": "string",
+   *         "tax_identifier": "string",
+   *         "country": {},
+   *         "legal_name": "string",
+   *         "entity_level": "PARENT",
+   *         "registration_date": "string",
+   *         "mailing_address": {},
+   *         "physical_address": {},
+   *         "parent_id": "string",
+   *         "parent": {},
+   *         "management_type": "PEO",
+   *         "company_id": "string",
+   *         "company": {}
+   *       }
+   *     ],
+   *     "physical_address": {
+   *       "type": "HOME",
+   *       "formatted": "string",
+   *       "street_address": "string",
+   *       "locality": "string",
+   *       "region": "string",
+   *       "postal_code": "string",
+   *       "country": "AF"
+   *     },
+   *     "primary_email": "string",
+   *     "legal_name": "string",
+   *     "doing_business_as_name": "string",
+   *     "phone": "string",
+   *     "name": "string"
+   *   }
+   * }
+   * ```
    */
   list(query: SSOMeListParams | null | undefined = {}, options?: RequestOptions): APIPromise<SSOMe> {
     return this._client.get('/sso-me/', { query, ...options });