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

package/resources/business-partners.d.mts

@@ -16,18 +16,356 @@ export declare class BusinessPartners extends APIResource {
      * - Filterable fields: `worker_id`, `business_partner_group_id`
      * - Expandable fields: `business_partner_group`, `worker`, `client_group`
      * - Sortable fields: `id`, `created_at`, `updated_at`
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /business-partners/?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",
+     *       "business_partner_group_id": "string",
+     *       "business_partner_group": {
+     *         "id": "string",
+     *         "created_at": "string",
+     *         "updated_at": "string",
+     *         "name": "string",
+     *         "domain": "HR",
+     *         "default_business_partner_id": "string",
+     *         "default_business_partner": {}
+     *       },
+     *       "worker_id": "string",
+     *       "worker": {
+     *         "id": "string",
+     *         "created_at": "string",
+     *         "updated_at": "string",
+     *         "user_id": "string",
+     *         "user": {},
+     *         "is_manager": "string",
+     *         "manager_id": "string",
+     *         "manager": {},
+     *         "legal_entity_id": "string",
+     *         "legal_entity": {},
+     *         "country": "AF",
+     *         "start_date": "string",
+     *         "end_date": "string",
+     *         "number": "string",
+     *         "work_email": "string",
+     *         "personal_email": "string",
+     *         "status": "INIT",
+     *         "location": {},
+     *         "employment_type_id": "string",
+     *         "employment_type": {},
+     *         "gender": "MALE",
+     *         "date_of_birth": "string",
+     *         "race": "BLACK",
+     *         "ethnicity": "HISPANIC_OR_LATINO",
+     *         "citizenship": "AF",
+     *         "compensation_id": "string",
+     *         "compensation": {},
+     *         "overtime_exemption": "EXEMPT",
+     *         "department_id": "string",
+     *         "department": {},
+     *         "teams_id": [],
+     *         "teams": [],
+     *         "title": "string",
+     *         "title_effective_date": "string",
+     *         "level_id": "string",
+     *         "level": {},
+     *         "job_function_id": "string",
+     *         "job_function": {},
+     *         "termination_details": {},
+     *         "pay_schedule_id": "string",
+     *         "work_schedule": {},
+     *         "compensation_grade": {},
+     *         "original_start_date": "string",
+     *         "custom_fields": [],
+     *         "country_fields": {},
+     *         "business_partners_id": [],
+     *         "business_partners": []
+     *       },
+     *       "client_group_id": "string",
+     *       "client_group": {
+     *         "id": "string",
+     *         "created_at": "string",
+     *         "updated_at": "string",
+     *         "display_name": "string",
+     *         "name": "string",
+     *         "app_owner_id": "string",
+     *         "group_type": "string",
+     *         "sub_group_type": "string",
+     *         "read_only": "string",
+     *         "description": "string",
+     *         "parent": "string",
+     *         "mutually_exclusive_key": "string",
+     *         "cumulatively_exhaustive_default": "string",
+     *         "include_terminated": "string",
+     *         "allow_non_employees": "string",
+     *         "can_override_role_states": "string",
+     *         "priority": "string",
+     *         "is_invisible": "string",
+     *         "ignore_prov_group_matching": "string"
+     *       },
+     *       "client_group_member_count": 0
+     *     }
+     *   ],
+     *   "next_link": "string"
+     * }
+     * ```
      */
     list(query?: BusinessPartnerListParams | null | undefined, options?: RequestOptions): PagePromise<BusinessPartnersPageCursorURL, BusinessPartner>;
     /**
      * Create a new business partner
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * POST /business-partners/ HTTP/1.1
+     * Host: rest.ripplingapis.com
+     * Content-Type: application/json
+     * Accept: application/json
+     * Rippling-Api-Version: 2024-08-01
+     *
+     * {
+     *   "business_partner_group_id": "business_partner_group_id",
+     *   "worker_id": "worker_id"
+     * }
+     *
+     * HTTP/1.1 200 OK
+     * Content-Type: application/json
+     *
+     * {
+     *   "id": "string",
+     *   "created_at": "string",
+     *   "updated_at": "string",
+     *   "business_partner_group_id": "string",
+     *   "business_partner_group": {
+     *     "id": "string",
+     *     "created_at": "string",
+     *     "updated_at": "string",
+     *     "name": "string"
+     *   },
+     *   "worker_id": "string",
+     *   "worker": {
+     *     "id": "string",
+     *     "created_at": "string",
+     *     "updated_at": "string",
+     *     "user_id": "string",
+     *     "user": {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string"
+     *     },
+     *     "is_manager": false,
+     *     "manager_id": "string",
+     *     "manager": {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string"
+     *     },
+     *     "legal_entity_id": "string",
+     *     "legal_entity": {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string"
+     *     },
+     *     "country": "AF",
+     *     "start_date": "string",
+     *     "end_date": "string",
+     *     "number": 0,
+     *     "work_email": "string",
+     *     "personal_email": "string",
+     *     "status": "INIT",
+     *     "location": {
+     *       "type": "REMOTE",
+     *       "work_location_id": "string"
+     *     },
+     *     "employment_type_id": "string",
+     *     "employment_type": {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "label": "string"
+     *     },
+     *     "gender": "MALE",
+     *     "date_of_birth": "string",
+     *     "race": "BLACK",
+     *     "ethnicity": "HISPANIC_OR_LATINO",
+     *     "citizenship": "AF",
+     *     "compensation_id": "string",
+     *     "compensation": {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string"
+     *     },
+     *     "overtime_exemption": "EXEMPT",
+     *     "department_id": "string",
+     *     "department": {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "name": "string"
+     *     },
+     *     "teams_id": [
+     *       "string"
+     *     ],
+     *     "teams": [
+     *       {
+     *         "id": "string",
+     *         "created_at": "string",
+     *         "updated_at": "string",
+     *         "name": "string"
+     *       }
+     *     ],
+     *     "title": "string",
+     *     "title_effective_date": "string",
+     *     "level_id": "string",
+     *     "level": {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "name": "string",
+     *       "parent_id": "string",
+     *       "parent": {
+     *         "id": "string",
+     *         "created_at": "string",
+     *         "updated_at": "string",
+     *         "name": "string"
+     *       },
+     *       "global_level": 0,
+     *       "description": "string"
+     *     },
+     *     "job_function_id": "string",
+     *     "job_function": {
+     *       "id": "string",
+     *       "created_at": "string",
+     *       "updated_at": "string",
+     *       "name": "string"
+     *     },
+     *     "termination_details": {
+     *       "type": "VOLUNTARY",
+     *       "reason": "string"
+     *     },
+     *     "pay_schedule_id": "string",
+     *     "work_schedule": {},
+     *     "compensation_grade": {
+     *       "id": "string",
+     *       "label": "string"
+     *     },
+     *     "original_start_date": "string",
+     *     "custom_fields": [
+     *       null
+     *     ],
+     *     "country_fields": {
+     *       "us": {
+     *         "ssn": "string"
+     *       },
+     *       "ca": {
+     *         "sin": "string"
+     *       },
+     *       "nz": {
+     *         "ird_number": "string"
+     *       }
+     *     },
+     *     "business_partners_id": [
+     *       "string"
+     *     ],
+     *     "business_partners": [
+     *       {
+     *         "id": "string",
+     *         "created_at": "string",
+     *         "updated_at": "string",
+     *         "business_partner_group_id": "string",
+     *         "business_partner_group": {},
+     *         "worker_id": "string",
+     *         "worker": {},
+     *         "client_group_id": "string",
+     *         "client_group": {},
+     *         "client_group_member_count": "string"
+     *       }
+     *     ]
+     *   },
+     *   "client_group_id": "string",
+     *   "client_group": {
+     *     "id": "string",
+     *     "created_at": "string",
+     *     "updated_at": "string",
+     *     "display_name": "string",
+     *     "name": "string",
+     *     "app_owner_id": "string",
+     *     "group_type": "string",
+     *     "sub_group_type": "string",
+     *     "read_only": false,
+     *     "description": "string",
+     *     "parent": "string",
+     *     "mutually_exclusive_key": "string",
+     *     "cumulatively_exhaustive_default": false,
+     *     "include_terminated": false,
+     *     "allow_non_employees": false,
+     *     "can_override_role_states": false,
+     *     "priority": 0,
+     *     "is_invisible": false,
+     *     "ignore_prov_group_matching": false
+     *   },
+     *   "client_group_member_count": 0
+     * }
+     * ```
      */
     create(body: BusinessPartnerCreateParams, options?: RequestOptions): APIPromise<BusinessPartner>;
     /**
      * Retrieve a specific business partner
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * GET /business-partners/{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, query?: BusinessPartnerRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<BusinessPartnerRetrieveResponse>;
     /**
      * Delete a business partner
+     *
+     * @example HTTP
+     * Representative request and response shapes.
+     * ```
+     * DELETE /business-partners/{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>;
 }

package/resources/business-partners.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"business-partners.d.mts","sourceRoot":"","sources":["../src/resources/business-partners.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,wBAAwB,sCAAkC;AACtE,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,KAAK,cAAc,sCAAkC;AAC5D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAEhE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,eAAe,CAAC;IAO9D;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIhG;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;AAE3E,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,wBAAwB,CAAC,oBAAoB,CAAC;IAEvE;;;;OAIG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,MAAM,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;CACrB;AAED,yBAAiB,IAAI,CAAC;IACpB,UAAiB,KAAK;QACpB,eAAe,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;KAC9C;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,IAAI,EAAE,eAAe;CAAG;AAEjF,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
+{"version":3,"file":"business-partners.d.mts","sourceRoot":"","sources":["../src/resources/business-partners.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,wBAAwB,sCAAkC;AACtE,OAAO,KAAK,UAAU,sBAAkB;AACxC,OAAO,KAAK,cAAc,sCAAkC;AAC5D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAEhE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyHG;IACH,IAAI,CACF,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,eAAe,CAAC;IAO9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoMG;IACH,MAAM,CAAC,IAAI,EAAE,2BAA2B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIhG;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC,eAAe,CAAC,CAAC;AAE3E,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,wBAAwB,CAAC,oBAAoB,CAAC;IAEvE;;;;OAIG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC;IAEzC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,MAAM,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC;CACrB;AAED,yBAAiB,IAAI,CAAC;IACpB,UAAiB,KAAK;QACpB,eAAe,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;KAC9C;IAED,UAAiB,KAAK,CAAC;QACrB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;SACjB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,IAAI,EAAE,eAAe;CAAG;AAEjF,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,6BAA6B;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,IAAI,IAAI,IAAI,EACjB,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}