Planning Center API Client

https://www.npmjs.com/package/@planningcenter/api-client
Admin
A JavaScript library that provides a client for interacting with Planning Center's Graph API as well...
Tokens:16,225
Snippets:169
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install @planningcenter/api-client

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Install the package using yarn.

```bash
yarn add @planningcenter/api-client
```

--------------------------------

### Client Initialization and GET Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=code

Demonstrates how to initialize the API client and make a GET request, including specifying fields for sparse fieldsets.

```APIDOC
## Client Initialization and GET Request

### Description
Initialize the client with your API root and version, then use the `get` method to fetch data. The `get` method enforces sparse fieldsets by requiring the `fields` key in the data object.

### Method
`client.get(options)`

### Parameters
#### Request Body (`options`)
- **url** (string) - Required - The endpoint URL to request.
- **data** (object) - Optional - An object containing request parameters such as `fields`, `where`, `include`, `order`, `perPage`, and `walk`.
  - **fields** (object) - Required for GET requests - Defines the fields to include for each resource type.
    - **Plan** (array of strings) - Example: `['dates', 'series', 'title']`
    - **Series** (array of strings) - Example: `['title', 'artwork_for_dashboard']`
  - **where** (object) - Optional - Filtering criteria.
  - **include** (string or array of strings) - Optional - Related resources to include.
  - **order** (string) - Optional - Sorting order.
  - **perPage** (number) - Optional - Number of items per page (default: 100).
  - **walk** (boolean) - Optional - If true, fetches all pages of results.

### Request Example
```javascript
import { Client } from "@planningcenter/api-client"
const client = new Client({ root: `${window.location.origin}/~api/services/v2/`, version: "2018-11-01" })

client.get({
  url: '/plans',
  data: {
    fields: {
      Plan: ['dates', 'series', 'title'],
    },
  }
})
```

### Response
#### Success Response (200)
Returns a promise that resolves with transformed response data.
```

--------------------------------

### General Usage

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Demonstrates how to initialize the API client and make a basic GET request.

```APIDOC
## General Usage

### Description
Initialize the client with your API endpoint and version, then use methods like `get`, `patch`, `post`, and `delete` to interact with the API.

### Code Example
```javascript
import { Client } from "@planningcenter/api-client"
const client = new Client({ root: `${window.location.origin}/~api/services/v2/`, version: "2018-11-01" })

client.get({
  url: '/plans',
  data: {
    fields: {
      Plan: ['dates', 'series', 'title'],
    },
  }
})
```
```

--------------------------------

### Client Initialization and General Usage

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=code

Demonstrates how to initialize the API client with a root URL and version, and how to make a basic GET request.

```APIDOC
## General Usage

```javascript
import { Client } from "@planningcenter/api-client"
const client = new Client({ root: `${window.location.origin}/~api/services/v2/`, version: "2018-11-01" })

client.get({
  url: '/plans',
  data: {
    fields: {
      Plan: ['dates', 'series', 'title'],
    },
  }
})
```

Client request methods will return a promise. When the promise is resolved, you'll be left with a transformed response.
```

--------------------------------

### GET Request with Query Parameters

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=code

Illustrates how to perform a GET request, including specifying sparse fieldsets, filtering with `where`, including related records, ordering results, and defining fields for multiple resource types.

```APIDOC
## Get

When making a request, the client will enforce the use of sparse fieldsets which requires the `fields` key.
```javascript
client.get({
  url: '/plans',
  data: {
    where: { title: 'Plan Title' },
    include: ['series'],
    order: 'created_at',
    fields: {
      Plan: ['dates', 'series', 'title'],
      Series: ['title', 'artwork_for_dashboard']
    },
  }
})
```

🚨 **NOTE** : When including records you also need to define the relation in `fields`. See the usage of `'series'` above.
```

--------------------------------

### GET Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Illustrates how to perform a GET request, including options for sparse fieldsets, inclusion of related records, filtering, ordering, and pagination.

```APIDOC
## GET Request

### Description
Fetches data from the API. Requires the `fields` key for sparse fieldsets. Supports `where` for filtering, `include` for related records, `order` for sorting, `perPage` for pagination, and `walk: true` to fetch all results from a collection.

### Method
`client.get(options)`

### Parameters
- `options.url` (string) - The API endpoint path.
- `options.data` (object) - An object containing request parameters:
  - `fields` (object) - Defines which fields to retrieve for each resource type.
  - `where` (object) - Filters the results based on specified criteria.
  - `include` (string or array) - Specifies related resources to include in the response.
  - `order` (string) - Specifies the order of the results.
  - `perPage` (number) - The number of items to return per page (default: 100).
  - `walk` (boolean) - If true, fetches all results from a collection.

### Request Example
```javascript
client.get({
  url: '/plans',
  data: {
    where: { title: 'Plan Title' },
    include: ['series'],
    order: 'created_at',
    fields: {
      Plan: ['dates', 'series', 'title'],
      Series: ['title', 'artwork_for_dashboard']
    },
  }
})
```

### Pagination Example
```javascript
client.get({
  url: '/plans',
  data: {
    perPage: 25,
    fields: {
      Plan: ['title'],
    },
  }
})
```

### Walk Example
```javascript
client.get({
  url: '/plans',
  data: {
    walk: true,
    fields: {
      Plan: ['title'],
    },
  }
})
```
```

--------------------------------

### GET Request with Sparse Fieldsets and Includes

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=dependencies

Illustrates how to use sparse fieldsets and include related records in a GET request.

```APIDOC
## GET Request with Sparse Fieldsets and Includes

### Description
Make a GET request specifying exact fields to retrieve and including related data.

### Method
`client.get()`

### Endpoint
`/plans` (example)

### Parameters
#### Request Body
- **url** (string) - Required - The API endpoint path.
- **data** (object) - Optional - Request parameters.
  - **fields** (object) - Required - Defines sparse fieldsets for resources (e.g., `Plan`, `Series`).
  - **include** (string or array) - Optional - Specifies related resources to be included in the response. When including records, their fields must also be defined in the `fields` object.
  - **where** (object) - Optional - Filtering criteria.
  - **order** (string) - Optional - Sorting order.

### Request Example
```javascript
client.get({
  url: '/plans',
  data: {
    where: { title: 'Plan Title' },
    include: ['series'],
    order: 'created_at',
    fields: {
      Plan: ['dates', 'series', 'title'],
      Series: ['title', 'artwork_for_dashboard']
    },
  }
})
```

🚨 **NOTE**: When including records, you must also define their fields in the `fields` object.
```

--------------------------------

### General Usage

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=versions

Instantiate the client and make a GET request to the API. The client handles data transformation for requests and responses.

```APIDOC
## General Usage
```javascript
import { Client } from "@planningcenter/api-client"
const client = new Client({ root: `${window.location.origin}/~api/services/v2/`, version: "2018-11-01" })

client.get({
  url: '/plans',
  data: {
    fields: {
      Plan: ['dates', 'series', 'title'],
    },
  }
})
```
Client request methods will return a promise. When the promise is resolved, you'll be left with a transformed response.
```

--------------------------------

### GET Request with Pagination (perPage)

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=dependents

Shows how to control the number of items returned per page in a GET request.

```APIDOC
#### Pagination
The default value of `perPage` is `100`. You can adjust this value in the `data` attribute:
```javascript
client.get({
  url: '/plans',
  data: {
    perPage: 25,
    fields: {
      Plan: ['title'],
    },
  }
})
```
```

--------------------------------

### Client Initialization and General Usage

Source: https://www.npmjs.com/package/@planningcenter/api-client

Demonstrates how to initialize the API client and make a basic GET request. The client enforces the use of sparse fieldsets, requiring the `fields` key in the request data.

```APIDOC
## General Usage

### Description
Initialize the client and make requests. Client request methods return a promise that resolves with a transformed response.

### Initialization
```javascript
import { Client } from "@planningcenter/api-client"
const client = new Client({ root: `${window.location.origin}/~api/services/v2/`, version: "2018-11-01" })
```

### GET Request Example
```javascript
client.get({
  url: '/plans',
  data: {
    fields: {
      Plan: ['dates', 'series', 'title'],
    },
  }
})
```
```

--------------------------------

### GET Request with Advanced Options

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=code

Illustrates advanced usage of the `get` method, including filtering with `where`, including related data, sorting with `order`, and pagination controls.

```APIDOC
## GET Request with Advanced Options

### Description
This example shows how to use the `get` method with additional parameters like `where` for filtering, `include` for related data, `order` for sorting, and pagination options `perPage` and `walk`.

### Method
`client.get(options)`

### Parameters
#### Request Body (`options`)
- **url** (string) - Required - The endpoint URL.
- **data** (object) - Optional - Request parameters.
  - **where** (object) - Optional - Filtering conditions. Example: `{ title: 'Plan Title' }`
  - **include** (string or array of strings) - Optional - Related resources to fetch. Example: `['series']`
  - **order** (string) - Optional - Sorting key. Example: `'created_at'`
  - **fields** (object) - Required - Specifies fields for each resource type. Example: `{ Plan: ['dates', 'series', 'title'], Series: ['title', 'artwork_for_dashboard'] }`
  - **perPage** (number) - Optional - Items per page (default: 100).
  - **walk** (boolean) - Optional - Fetch all results if true.

### Request Example
```javascript
client.get({
  url: '/plans',
  data: {
    where: { title: 'Plan Title' },
    include: ['series'],
    order: 'created_at',
    fields: {
      Plan: ['dates', 'series', 'title'],
      Series: ['title', 'artwork_for_dashboard']
    },
  }
})
```

🚨 **NOTE**: When including records, you must also define the relation in `fields`.
```

--------------------------------

### GET Request with Filtering and Fields

Source: https://www.npmjs.com/package/@planningcenter/api-client

Illustrates how to perform a GET request with advanced options including `where` for filtering, `include` for related records, `order` for sorting, and `fields` for specifying which attributes to retrieve for different resource types.

```APIDOC
## GET Request

### Description
Makes a GET request to the API. Enforces the use of sparse fieldsets, requiring the `fields` key. Related records can be included using the `include` parameter, but they must also be defined in `fields`.

### Method
GET

### Endpoint
`/plans` (example)

### Parameters
#### Request Body (data attribute)
- **url** (string) - Required - The endpoint path.
- **data** (object) - Required - Contains request parameters.
  - **where** (object) - Optional - Filters the results.
  - **include** (string) - Optional - Specifies related records to include.
  - **order** (string) - Optional - Specifies the sorting order.
  - **fields** (object) - Required - Specifies the attributes to retrieve for each resource type.
    - **Plan** (array of strings) - Attributes for the Plan resource.
    - **Series** (array of strings) - Attributes for the Series resource.

### Request Example
```javascript
client.get({
  url: '/plans',
  data: {
    where: { title: 'Plan Title' },
    include: ['series'],
    order: 'created_at',
    fields: {
      Plan: ['dates', 'series', 'title'],
      Series: ['title', 'artwork_for_dashboard']
    },
  }
})
```
```

--------------------------------

### GET Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=versions

Perform a GET request. The client enforces sparse fieldsets, requiring the `fields` key. Supports pagination and walking through collections.

```APIDOC
## Get
When making a request, the client will enforce the use of sparse fieldsets which requires the `fields` key.
```javascript
client.get({
  url: '/plans',
  data: {
    where: { title: 'Plan Title' },
    include: ['series'],
    order: 'created_at',
    fields: {
      Plan: ['dates', 'series', 'title'],
      Series: ['title', 'artwork_for_dashboard']
    },
  }
})
```

🚨 **NOTE** : When including records you also need to define the relation in `fields`. See the usage of `'series'` above.
#### Pagination
The default value of `perPage` is `100`. You can adjust this value in the `data` attribute:
```javascript
client.get({
  url: '/plans',
  data: {
    perPage: 25,
    fields: {
      Plan: ['title'],
    },
  }
})
```

If you need to return all results from a collection, instead of only the first page of results, you can include the `walk: true` attribute inside the `data` attribute:
```javascript
client.get({
  url: '/plans',
  data: {
    walk: true,
    fields: {
      Plan: ['title'],
    },
  }
})
```

This can be used in combination with `perPage` to make many smaller requests for a large collection of data.
```

--------------------------------

### GET Request to Fetch All Results (walk: true)

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=dependents

Demonstrates how to retrieve all results from a collection, not just the first page, by using the `walk: true` option.

```APIDOC
If you need to return all results from a collection, instead of only the first page of results, you can include the `walk: true` attribute inside the `data` attribute:
```javascript
client.get({
  url: '/plans',
  data: {
    walk: true,
    fields: {
      Plan: ['title'],
    },
  }
})
```

This can be used in combination with `perPage` to make many smaller requests for a large collection of data.
```

--------------------------------

### API Client GET Request with Pagination

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Adjust the number of items returned per page in a GET request. The default is 100.

```javascript
client.get({
  url: '/plans',
  data: {
    perPage: 25,
    fields: {
      Plan: ['title'],
    },
  }
})
```

--------------------------------

### GET Request with Pagination

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=dependencies

Shows how to control the number of results per page and fetch all results from a collection.

```APIDOC
## GET Request with Pagination

### Description
Control pagination for collection requests, including setting items per page and fetching all results.

### Method
`client.get()`

### Endpoint
`/plans` (example)

### Parameters
#### Request Body
- **url** (string) - Required - The API endpoint path.
- **data** (object) - Optional - Request parameters.
  - **perPage** (number) - Optional - The number of items to return per page. Defaults to 100.
  - **walk** (boolean) - Optional - If true, fetches all results from a collection across multiple requests.
  - **fields** (object) - Required for sparse fieldsets.

### Request Example (perPage)
```javascript
client.get({
  url: '/plans',
  data: {
    perPage: 25,
    fields: {
      Plan: ['title'],
    },
  }
})
```

### Request Example (walk)
```javascript
client.get({
  url: '/plans',
  data: {
    walk: true,
    fields: {
      Plan: ['title'],
    },
  }
})
```

This can be used in combination with `perPage` to make many smaller requests for a large collection of data.
```

--------------------------------

### DELETE Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=readme

Provides an example of how to delete a resource using a DELETE request.

```APIDOC
## Delete

```javascript
client.delete({ url: `/series/${seriesId}` })
```
```

--------------------------------

### API Client GET Request with Sparse Fieldsets

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Perform a GET request, enforcing sparse fieldsets with the 'fields' key. Include related records by defining them in 'fields'.

```javascript
client.get({
  url: '/plans',
  data: {
    where: { title: 'Plan Title' },
    include: ['series'],
    order: 'created_at',
    fields: {
      Plan: ['dates', 'series', 'title'],
      Series: ['title', 'artwork_for_dashboard']
    },
  }
})
```

--------------------------------

### GET Request with Pagination and Walk

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=code

Shows how to control the number of results per page using `perPage` and how to retrieve all results from a collection by setting `walk: true`.

```APIDOC
#### Pagination
The default value of `perPage` is `100`. You can adjust this value in the `data` attribute:
```javascript
client.get({
  url: '/plans',
  data: {
    perPage: 25,
    fields: {
      Plan: ['title'],
    },
  }
})
```

If you need to return all results from a collection, instead of only the first page of results, you can include the `walk: true` attribute inside the `data` attribute:
```javascript
client.get({
  url: '/plans',
  data: {
    walk: true,
    fields: {
      Plan: ['title'],
    },
  }
})
```

This can be used in combination with `perPage` to make many smaller requests for a large collection of data.
```

--------------------------------

### DELETE Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=code

Provides an example of how to delete a resource using a DELETE request, specifying the resource ID in the URL.

```APIDOC
### Delete
```javascript
client.delete({ url: `/series/${seriesId}` })
```
```

--------------------------------

### API Client GET Request to Walk Collections

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Retrieve all results from a collection by setting 'walk: true' in the data attribute. This can be combined with 'perPage' for large collections.

```javascript
client.get({
  url: '/plans',
  data: {
    walk: true,
    fields: {
      Plan: ['title'],
    },
  }
})
```

--------------------------------

### Paginate GET Requests

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=versions

Control the number of results per page with the `perPage` attribute. The default is 100. For fetching all results from a collection, use `walk: true`.

```javascript
client.get({
  url: '/plans',
  data: {
    perPage: 25,
    fields: {
      Plan: ['title'],
    },
  }
})
```

```javascript
client.get({
  url: '/plans',
  data: {
    walk: true,
    fields: {
      Plan: ['title'],
    },
  }
})
```

--------------------------------

### POST Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=readme

Demonstrates how to create a new resource using a POST request, including setting attributes and relationships.

```APIDOC
## Post

```javascript
client.post({
  url: '/series',
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: {
      type: 'Series',
      attributes: { name: 'New Series Name' },
      relationships: {
        plan: {
          data: { type: 'Plan', id }
        }
      }
    }
  }
})
```
```

--------------------------------

### POST Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=code

Shows how to create a new resource using the `post` method, including specifying fields, resource data, and relationships.

```APIDOC
## POST Request

### Description
Use the `post` method to create a new resource. You need to specify the fields, the resource's type and attributes, and any relationships.

### Method
`client.post(options)`

### Parameters
#### Request Body (`options`)
- **url** (string) - Required - The endpoint URL for creating the resource. Example: `/series`
- **data** (object) - Optional - Contains request parameters.
  - **fields** (object) - Specifies fields for the resource. Example: `{ Series: 'title,artwork_for_dashboard' }`
  - **data** (object) - Required - The resource data to create.
    - **type** (string) - The type of the resource. Example: `'Series'`
    - **attributes** (object) - The attributes of the new resource. Example: `{ name: 'New Series Name' }`
    - **relationships** (object) - Optional - Defines relationships to other resources. Example: `{ plan: { data: { type: 'Plan', id } } }`

### Request Example
```javascript
client.post({
  url: '/series',
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: {
      type: 'Series',
      attributes: { name: 'New Series Name' },
      relationships: {
        plan: {
          data: { type: 'Plan', id }
        }
      }
    }
  }
})
```
```

--------------------------------

### Initialize API Client

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Initialize the client with the root API endpoint and version. This client can be used for various API requests.

```javascript
import { Client } from "@planningcenter/api-client"
const client = new Client({ root: `${window.location.origin}/~api/services/v2/`, version: "2018-11-01" })

client.get({
  url: '/plans',
  data: {
    fields: {
      Plan: ['dates', 'series', 'title'],
    },
  }
})
```

--------------------------------

### POST Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=dependencies

Shows how to create a new resource using a POST request.

```APIDOC
## POST Request

### Description
Create a new resource by sending a POST request with the resource's type and attributes, and optionally its relationships.

### Method
`client.post()`

### Endpoint
`/series` (example)

### Parameters
#### Request Body
- **url** (string) - Required - The API endpoint path for creating the resource.
- **data** (object) - Required - An object containing the resource data.
  - **fields** (string) - Optional - Comma-separated list of fields to include in the response.
  - **data** (object) - Required - The resource to create.
    - **type** (string) - Required - The type of the resource.
    - **attributes** (object) - Required - An object containing the attributes of the new resource.
    - **relationships** (object) - Optional - An object defining relationships to other resources.

### Request Example
```javascript
client.post({
  url: '/series',
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: {
      type: 'Series',
      attributes: { name: 'New Series Name' },
      relationships: {
        plan: {
          data: { type: 'Plan', id }
        }
      }
    }
  }
})
```
```

--------------------------------

### POST Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=code

Shows how to create a new resource using a POST request, including specifying fields, data, and relationships.

```APIDOC
### Post
```javascript
client.post({
  url: '/series',
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: {
      type: 'Series',
      attributes: { name: 'New Series Name' },
      relationships: {
        plan: {
          data: { type: 'Plan', id }
        }
      }
    }
  }
})
```
```

--------------------------------

### POST Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Creates a new resource on the API.

```APIDOC
## POST Request

### Description
Creates a new resource. Requires `fields` to specify the resource details and `data` object containing the resource `type`, `attributes`, and optionally `relationships`.

### Method
`client.post(options)`

### Parameters
- `options.url` (string) - The API endpoint path for creating the resource.
- `options.data` (object) - An object containing:
  - `fields` (object) - Specifies the fields for the new resource.
  - `data` (object) - The resource object with `type`, `attributes`, and optionally `relationships`.

### Request Example
```javascript
client.post({
  url: '/series',
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: {
      type: 'Series',
      attributes: { name: 'New Series Name' },
      relationships: {
        plan: {
          data: { type: 'Plan', id }
        }
      }
    }
  }
})
```
```

--------------------------------

### API Client POST Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Create a new resource using a POST request. Include fields, data, and relationships.

```javascript
client.post({
  url: '/series',
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: {
      type: 'Series',
      attributes: { name: 'New Series Name' },
      relationships: {
        plan: {
          data: { type: 'Plan', id }
        }
      }
    }
  }
})
```

--------------------------------

### PATCH Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=dependencies

Demonstrates how to update an existing resource using a PATCH request.

```APIDOC
## PATCH Request

### Description
Update an existing resource by sending a PATCH request with the resource's ID and the data to be modified.

### Method
`client.patch()`

### Endpoint
`/series/${seriesId}` (example)

### Parameters
#### Request Body
- **url** (string) - Required - The API endpoint path, including the ID of the resource to update.
- **data** (object) - Required - An object containing the update payload.
  - **fields** (string) - Optional - Comma-separated list of fields to include in the response.
  - **data** (object) - Required - The resource data to update.
    - **type** (string) - Required - The type of the resource.
    - **id** (string) - Required - The ID of the resource.
    - **attributes** (object) - Required - An object containing the attributes to update.

### Request Example
```javascript
client.patch({
  url: `/series/${seriesId}`,
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: { type: 'Series', attributes: { name: 'New Series Name' } }
  }
})
```
```

--------------------------------

### POST Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=versions

Perform a POST request to create a new resource. Requires the endpoint URL and a data object specifying the type, attributes, and optionally relationships.

```APIDOC
## Post
```javascript
client.post({
  url: '/series',
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: {
      type: 'Series',
      attributes: { name: 'New Series Name' },
      relationships: {
        plan: {
          data: { type: 'Plan', id }
        }
      }
    }
  }
})
```
```

--------------------------------

### PATCH Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=code

Demonstrates how to update an existing resource using the `patch` method, specifying the resource ID, fields, and the data to be updated.

```APIDOC
## PATCH Request

### Description
Use the `patch` method to update an existing resource. You need to provide the resource's ID in the URL and specify the fields and new data within the request body.

### Method
`client.patch(options)`

### Parameters
#### Request Body (`options`)
- **url** (string) - Required - The URL of the resource to update, including its ID. Example: `/series/${seriesId}`
- **data** (object) - Optional - Contains request parameters.
  - **fields** (object) - Specifies fields for the resource. Example: `{ Series: 'title,artwork_for_dashboard' }`
  - **data** (object) - Required - The resource data to update.
    - **type** (string) - The type of the resource. Example: `'Series'`
    - **attributes** (object) - The attributes to update. Example: `{ name: 'New Series Name' }`

### Request Example
```javascript
client.patch({
  url: `/series/${seriesId}`,
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: { type: 'Series', attributes: { name: 'New Series Name' } }
  }
})
```
```

--------------------------------

### PATCH Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=code

Demonstrates how to update an existing resource using a PATCH request, specifying the resource ID, fields to return, and the data to update.

```APIDOC
### Patch
```javascript
client.patch({
  url: `/series/${seriesId}`,
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: { type: 'Series', attributes: { name: 'New Series Name' } }
  }
})
```
```

--------------------------------

### DELETE Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=dependencies

Demonstrates how to delete a resource using a DELETE request.

```APIDOC
## DELETE Request

### Description
Delete a specific resource by providing its URL.

### Method
`client.delete()`

### Endpoint
`/series/${seriesId}` (example)

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the resource to delete, including its ID.

### Request Example
```javascript
client.delete({ url: `/series/${seriesId}` })
```
```

--------------------------------

### Helper Function: transformRequestData

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=code

Explains and demonstrates the `transformRequestData` helper function, which converts camelCase request parameters into an API-friendly format.

```APIDOC
### `transformRequestData`
Takes an object with camelCase request parameters and transforms to a more api friendly format.
#### Input
```javascript
import { transformRequestData } from "@planningcenter/api-client"

transformRequestData({
  fields: { Song: ["title", "arrangements"], Arrangement: ["name"] },
  include: "arrangements",
  where: { title: "I Like Bugs" },
})
```

#### Output
```json
{
  "fields[Song]": "title,arrangements",
  "fields[Arrangement]": "name",
  include: "arrangements",
  per_page: 100,
  "where[title]": "I Like Bugs",
}
```
```

--------------------------------

### DELETE Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=code

Explains how to delete a resource using the `delete` method by providing the resource's URL.

```APIDOC
## DELETE Request

### Description
Use the `delete` method to remove a resource. You only need to provide the URL of the resource to be deleted.

### Method
`client.delete(options)`

### Parameters
#### Request Body (`options`)
- **url** (string) - Required - The URL of the resource to delete. Example: `/series/${seriesId}`

### Request Example
```javascript
client.delete({ url: `/series/${seriesId}` })
```
```

--------------------------------

### transformResponse Helper

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=dependencies

Explains the `transformResponse` helper function for processing API responses.

```APIDOC
## `transformResponse` Helper Function

### Description
This helper function takes a JSON API spec-adhering response and transforms it into a more JavaScript-friendly format.

### Input
```javascript
import { transformResponse } from "@planningcenter/api-client"

transformResponse({
  "data": {
    "type": "Person",
    "id": "123",
    "attributes": {
      "first_name": "Marvin",
      "last_name": "Gaye"
    },
    "relationships": {
      "top_song": {
        "data": {
          "type": "Song",
          "id": "456"
        }
      },
      "instruments": {
        "data": [{
          "type": "Instrument",
          "id": "789"
        }]
      }
    },
    "links": { ... }
  },
  "included": [
    {
      "type": "Instrument",
      "id": "789",
      "attributes": {
        "name": "Piano"
      }
    }
  ],
  "meta": {
    "parent": {
      "id": "1",
      "type": "Organization"
    }
  }
})
```

### Output
```javascript
{
  data: {
    // string IDs are parsed into integers
    id: 123,
    type: "Person",

    // all keys are camel-cased
    firstName: "Marvin",
    lastName: "Gaye",

    // belongs to relationships are given a singular foreign key property
    topSongId: 456,
    topSongType: "Song",

    // relationships not also `included` are given a property with a null value
    topSong: null,

    // has many relationships are given a plural foreign key property
    instrumentIds: [789],

    // included records are gathered via relationships & placed in a collection:
    instruments: [
      { id: 789, type: "Instrument", name: "Piano" },
    ],

    links: {}
  },
  // response meta is available in case you need it
  meta: { parent: { id: "1", type: "Organization" } }
}
```
```

--------------------------------

### Helper Function: transformResponse

Source: https://www.npmjs.com/package/%40planningcenter/api-client?activeTab=code

Explains and demonstrates the `transformResponse` helper function, which converts a JSON API spec response into a more JavaScript-friendly format.

```APIDOC
### `transformResponse`
Takes an JSON API spec-adhering response and transforms it to a more appropriate format for JavaScript.
#### Input
```javascript
import { transformResponse } from "@planningcenter/api-client"

transformResponse({
  "data": {
    "type": "Person",
    "id": "123",
    "attributes": {
      "first_name": "Marvin",
      "last_name": "Gaye"
    },
    "relationships": {
      "top_song": {
        "data": {
          "type": "Song",
          "id": "456"
        }
      },
      "instruments": {
        "data": [{
          "type": "Instrument",
          "id": "789"
        }]
      }
    },
    "links": { ... }
  },
  "included": [
    {
      "type": "Instrument",
      "id": "789",
      "attributes": {
        "name": "Piano"
      }
    }
  ],
  "meta": {
    "parent": {
      "id": "1",
      "type": "Organization"
    }
  }
})
```

#### Output
```javascript
{
  data: {
    // string IDs are parsed into integers
    id: 123,
    type: "Person",

    // all keys are camel-cased
    firstName: "Marvin",
    lastName: "Gaye",

    // belongs to relationships are given a singular foreign key property
    topSongId: 456,
    topSongType: "Song",

    // relationships not also `included` are given a property with a null value
    topSong: null,

    // has many relationships are given a plural foreign key property
    instrumentIds: [789],

    // included records are gathered via relationships & placed in a collection:
    instruments: [
      { id: 789, type: "Instrument", name: "Piano" },
    ],

    links: {}
  },
  // response meta is available in case you need it
  meta: { parent: { id: "1", type: "Organization" } }
}
```
```

--------------------------------

### Helper Function: transformResponse

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=code

Explains the `transformResponse` helper function, which converts a JSON API spec response into a more JavaScript-friendly format.

```APIDOC
## Helper Function: transformResponse

### Description
The `transformResponse` function takes a JSON API compliant response and restructures it into a more convenient format for JavaScript developers. This includes parsing IDs to integers, camel-casing keys, and organizing included resources.

### Input
A JSON API spec-adhering response object.

### Output
A transformed response object suitable for JavaScript consumption.

### Usage Example
```javascript
import { transformResponse } from "@planningcenter/api-client"

transformResponse({
  "data": {
    "type": "Person",
    "id": "123",
    "attributes": {
      "first_name": "Marvin",
      "last_name": "Gaye"
    },
    "relationships": {
      "top_song": {
        "data": {
          "type": "Song",
          "id": "456"
        }
      },
      "instruments": {
        "data": [
          {
            "type": "Instrument",
            "id": "789"
          }
        ]
      }
    },
    "links": { ... }
  },
  "included": [
    {
      "type": "Instrument",
      "id": "789",
      "attributes": {
        "name": "Piano"
      }
    }
  ],
  "meta": {
    "parent": {
      "id": "1",
      "type": "Organization"
    }
  }
})
```

#### Output Example
```json
{
  data: {
    id: 123,
    type: "Person",
    firstName: "Marvin",
    lastName: "Gaye",
    topSongId: 456,
    topSongType: "Song",
    topSong: null,
    instrumentIds: [789],
    instruments: [
      { id: 789, type: "Instrument", name: "Piano" },
    ],
    links: {}
  },
  meta: { parent: { id: "1", type: "Organization" } }
}
```
```

--------------------------------

### transformRequestData Helper

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=versions

A helper function to transform camelCase request parameters into an API-friendly format, suitable for manual data preparation.

```APIDOC
## `transformRequestData`
Takes an object with camelCase request parameters and transforms to a more api friendly format.
#### Input
```javascript
import { transformRequestData } from "@planningcenter/api-client"

transformRequestData({
  fields: { Song: ["title", "arrangements"], Arrangement: ["name"] },
  include: "arrangements",
  where: { title: "I Like Bugs" },
})
```

#### Output
```json
{
  "fields[Song]": "title,arrangements",
  "fields[Arrangement]": "name",
  include: "arrangements",
  per_page: 100,
  "where[title]": "I Like Bugs",
}
```
```

--------------------------------

### transformRequestData Helper

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

A helper function to transform request data from camelCase to an API-friendly format.

```APIDOC
## `transformRequestData` Helper

### Description
This function takes an object with camelCase request parameters and converts them into a format suitable for the API, such as converting `fields[Resource]` to `fields[Resource]` and `perPage` to `per_page`.

### Usage
```javascript
import { transformRequestData } from "@planningcenter/api-client"

transformRequestData({
  fields: { Song: ["title", "arrangements"], Arrangement: ["name"] },
  include: "arrangements",
  where: { title: "I Like Bugs" },
})
```

### Output Example
```json
{
  "fields[Song]": "title,arrangements",
  "fields[Arrangement]": "name",
  include: "arrangements",
  per_page: 100,
  "where[title]": "I Like Bugs"
}
```
```

--------------------------------

### Helper Function: transformRequestData

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=code

Details the `transformRequestData` helper function, which converts camelCase request parameters into an API-friendly format.

```APIDOC
## Helper Function: transformRequestData

### Description
The `transformRequestData` function is a utility that takes an object with camelCase request parameters and converts them into a format suitable for the API, such as converting `fields[Resource]` to `fields[Resource]` and `perPage` to `per_page`.

### Input
An object with camelCase request parameters.

### Output
An object with API-friendly parameter names.

### Usage Example
```javascript
import { transformRequestData } from "@planningcenter/api-client"

transformRequestData({
  fields: { Song: ["title", "arrangements"], Arrangement: ["name"] },
  include: "arrangements",
  where: { title: "I Like Bugs" },
})
```

#### Output Example
```json
{
  "fields[Song]": "title,arrangements",
  "fields[Arrangement]": "name",
  include: "arrangements",
  per_page: 100,
  "where[title]": "I Like Bugs"
}
```
```

--------------------------------

### Helper Function: transformRequestData

Source: https://www.npmjs.com/package/@planningcenter/api-client

Provides a utility function to transform request data from a camelCase format to an API-friendly format, useful for manual data preparation.

```APIDOC
## Helper Functions

### `transformRequestData`

#### Description
Takes an object with camelCase request parameters and transforms it into a more API-friendly format.

#### Input Example
```javascript
import { transformRequestData } from "@planningcenter/api-client"

transformRequestData({
  fields: { Song: ["title", "arrangements"], Arrangement: ["name"] },
  include: "arrangements",
  where: { title: "I Like Bugs" },
})
```

#### Output Example
```json
{
  "fields[Song]": "title,arrangements",
  "fields[Arrangement]": "name",
  "include": "arrangements",
  "per_page": 100,
  "where[title]": "I Like Bugs"
}
```
```

--------------------------------

### API Client PATCH Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Update a resource using a PATCH request. Specify fields and the data to be updated.

```javascript
client.patch({
  url: `/series/${seriesId}`,
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: { type: 'Series', attributes: { name: 'New Series Name' } }
  }
})
```

--------------------------------

### Transform Request Data

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Use the `transformRequestData` helper to convert camelCase request parameters into an API-friendly format. This is useful for manual data preparation.

```javascript
import { transformRequestData } from "@planningcenter/api-client"

transformRequestData({
  fields: { Song: ["title", "arrangements"], Arrangement: ["name"] },
  include: "arrangements",
  where: { title: "I Like Bugs" },
})
```

--------------------------------

### PATCH Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Updates an existing resource on the API.

```APIDOC
## PATCH Request

### Description
Updates an existing resource. Requires the `fields` to specify which attributes to update and the `data` object containing the resource type, attributes, and relationships to modify.

### Method
`client.patch(options)`

### Parameters
- `options.url` (string) - The API endpoint path for the resource to update.
- `options.data` (object) - An object containing:
  - `fields` (object) - Specifies the fields to be updated.
  - `data` (object) - The resource object with `type`, `attributes`, and optionally `relationships`.

### Request Example
```javascript
client.patch({
  url: `/series/${seriesId}`,
  data: {
    fields: { Series: 'title,artwork_for_dashboard' },
    data: { type: 'Series', attributes: { name: 'New Series Name' } }
  }
})
```
```

--------------------------------

### API Client DELETE Request

Source: https://www.npmjs.com/package/%40planningcenter/api-client/v/3.0.2?activeTab=readme

Delete a resource using a DELETE request by providing the resource's URL.

```javascript
client.delete({ url: `/series/${seriesId}` })
```

--------------------------------

### Helper Function: transformResponse

Source: https://www.npmjs.com/package/@planningcenter/api-client

Offers a utility function to transform JSON API spec responses into a more JavaScript-friendly format, including camelCasing keys and parsing IDs.

```APIDOC
### `transformResponse`

#### Description
Takes a JSON API spec-adhering response and transforms it into a more appropriate format for JavaScript.

#### Input Example
```javascript
import { transformResponse } from "@planningcenter/api-client"

transformResponse({
  "data": {
    "type": "Person",
    "id": "123",
    "attributes": {
      "first_name": "Marvin",
      "last_name": "Gaye"
    },
    "relationships": {
      "top_song": {
        "data": {
          "type": "Song",
          "id": "456"
        }
      },
      "instruments": {
        "data": [{
          "type": "Instrument",
          "id": "789"
        }]
      }
    },
    "links": { ... }
  },
  "included": [
    {
      "type": "Instrument",
      "id": "789",
      "attributes": {
        "name": "Piano"
      }
    }
  ],
  "meta": {
    "parent": {
      "id": "1",
      "type": "Organization"
    }
  }
})
```

#### Output Example
```javascript
{
  data: {
    // string IDs are parsed into integers
    id: 123,
    type: "Person",

    // all keys are camel-cased
    firstName: "Marvin",
    lastName: "Gaye",

    // belongs to relationships are given a singular foreign key property
    topSongId: 456,
    topSongType: "Song",

    // relationships not also `included` are given a property with a null value
    topSong: null,

    // has many relationships are given a plural foreign key property
    instrumentIds: [789],

    // included records are gathered via relationships & placed in a collection:
    instruments: [
      { id: 789, type: "Instrument", name: "Piano" },
    ],

    links: {}
  },
  // response meta is available in case you need it
  meta: { parent: { id: "1", type: "Organization" } }
}
```
```
Tokens:
Raw