ebay-api/dist/api/restful/commerce/charity/index.js

eBay API for Node and Browser

import Restful from '../../index.js';
/**
 * The Charity API allows third-party developers to search for and access details on supported charitable organizations.
 */
export default class Charity extends Restful {
    get basePath() {
        return '/commerce/charity/v1';
    }
    /**
     * This call is used to retrieve detailed information about supported charitable organizations.
     *
     * @param charityOrgId The unique ID of the charitable organization.
     */
    getCharityOrg(charityOrgId) {
        charityOrgId = encodeURIComponent(charityOrgId);
        return this.get(`/charity_org/${charityOrgId}`);
    }
    /**
     * This call is used to retrieve detailed information about supported charitable organizations.
     *
     * @param limit The number of items, from the result set, returned in a single page. Valid Values: 1-100 Default: 20
     * @param offset The number of items that will be skipped in the result set.
     * @param q A query string that matches the keywords in name, mission statement, or description.
     * @param registrationIds A comma-separated list of charitable organization registration IDs.
     */
    getCharityOrgs({ limit, offset, q, registrationIds }) {
        return this.get(`/charity_org`, {
            params: {
                limit,
                offset,
                q,
                registration_ids: registrationIds
            }
        });
    }
    /**
     * This call allows users to retrieve the details for a specific charitable organization using its legacy charity ID, which has also been referred to as the charity number, external ID, and PayPal Giving Fund ID.
     *
     * @param legacyCharityOrgId The legacy ID of the charitable organization.
     */
    getCharityOrgByLegacyId(legacyCharityOrgId) {
        return this.get(`/charity_org/get_charity_org_by_legacy_id`, {
            params: {
                legacy_charity_org_id: legacyCharityOrgId
            }
        });
    }
}
Charity.id = 'Charity';