Getbystatement

[johngeorgewright]

The query function was always a bit of a hack to automatically type pql options based on the method you were calling.

For example, instead of:

import { GoogleAdManager, LineItemService, pql } from '@dmgt/google-ad-manager-api'

const [response] = await client.getLineItemsByStatementAsync({
  filterStatement: {
    query: pql<LineItemService.LineItems>({
      limit: 10,
      where: {
        lineItemType: 'SPONSORSHIP'
      },
    }),
  },
})

You could write something simpler, like:

import { GoogleAdManager, pql, query } from '@dmgt/google-ad-manager-api'

const [response] = await query(client, 'getLineItemsByStatementAsync', {
  limit: 10,
  where: {
    lineItemType: 'SPONSORSHIP'
  },
})

With the above you didn't need to specify the LineItemService.LineItems type for the pql function... it was automatically figured out for you by the return type of getLineItemsByStatementAsync. The only problem with this, however, is that you had to know of the function "getLineItemsByStatementAsync".

This PR adds a very similar function called "getByStatement" which doesn't require the full function name... just the item name, plus we provide the available items as a union to make things even easier.

import { getByStatement, GoogleAdManager, pql } from '@dmgt/google-ad-manager-api'

const [response] = await getByStatement(client, 'lineItems', {
  limit: 10,
  where: {
    lineItemType: 'SPONSORSHIP'
  },
})

[github-actions]

🎉 This PR is included in version 8.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀