Skip to content

Commit d179b44

Browse files
sudasuda
authored
Merge pull request #167 from particle-iot/feature/sc-119755/align-http-api-with-the-public-api
Update the ledger methods
2 parents 2dda77f + f52d9e5 commit d179b44

File tree

2 files changed

+28
-28
lines changed

2 files changed

+28
-28
lines changed

‎src/Particle.js

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2290,17 +2290,17 @@ class Particle {
22902290
* @param {Object} options The options for creating the ledger definition.
22912291
* @param {Object} options.auth Access token
22922292
* @param {string} options.org The name of the organization.
2293-
* @param {LedgerDefinition} options.definition The ledger definition object.
2293+
* @param {Ledger} options.definition The ledger definition object.
22942294
* @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
22952295
* @param {Object} [options.context] Request context
22962296
*
2297-
* @returns {Promise<{body: {definition: ResponseLedgerDefinition}, statusCode: int}>} A promise that resolves to the created ledger definition data.
2297+
* @returns {Promise<{body: {ledger: ResponseLedger}, statusCode: int}>} A promise that resolves to the created ledger definition data.
22982298
*/
2299-
createLedgerDefinition({ auth, org, definition, headers, context }) {
2299+
createLedger({ auth, org, ledger, headers, context }) {
23002300
return this.post({
23012301
uri: `/v1/orgs/${org}/ledgers`,
23022302
auth,
2303-
data: { definition },
2303+
data: { ledger },
23042304
headers,
23052305
context
23062306
});
@@ -2316,9 +2316,9 @@ class Particle {
23162316
* @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
23172317
* @param {Object} [options.context] Request context
23182318
*
2319-
* @returns {Promise<{body: {definition: ResponseLedgerDefinition}, statusCode: int}>} A promise that resolves to the specified ledger definition data.
2319+
* @returns {Promise<{body: {ledger: ResponseLedger}, statusCode: int}>} A promise that resolves to the specified ledger definition data.
23202320
*/
2321-
getLedgerDefinition({ auth, org, ledgerName, headers, context }) {
2321+
getLedger({ auth, org, ledgerName, headers, context }) {
23222322
return this.get({
23232323
uri: `/v1/orgs/${org}/ledgers/${ledgerName}`,
23242324
auth,
@@ -2334,17 +2334,17 @@ class Particle {
23342334
* @param {Object} options.auth The authentication object with the API key.
23352335
* @param {string} options.org The unique identifier of the organization.
23362336
* @param {string} options.ledgerName Name of the ledger definition to update.
2337-
* @param {LedgerDefinition} options.definition The ledger definition object.
2337+
* @param {Ledger} options.ledger The ledger definition object.
23382338
* @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
23392339
* @param {Object} [options.context] Request context.
23402340
*
2341-
* @returns {Promise<{body: {definition: ResponseLedgerDefinition}, statusCode: int}>} A promise that resolves to the updated ledger definition data.
2341+
* @returns {Promise<{body: {ledger: ResponseLedger}, statusCode: int}>} A promise that resolves to the updated ledger definition data.
23422342
*/
2343-
updateLedgerDefinition({ auth, org, ledgerName, definition, headers, context }) {
2343+
updateLedger({ auth, org, ledgerName, ledger, headers, context }) {
23442344
return this.put({
23452345
uri: `/v1/orgs/${org}/ledgers/${ledgerName}`,
23462346
auth,
2347-
data: { definition },
2347+
data: { ledger },
23482348
headers,
23492349
context
23502350
});
@@ -2360,9 +2360,9 @@ class Particle {
23602360
* @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
23612361
* @param {Object} [options.context] Request context.
23622362
*
2363-
* @returns {Promise<{body: {archived: Boolean}, statusCode: int}>} A promise that resolves to an object confirming the ledger definition was archived.
2363+
* @returns {Promise<{body: undefined, statusCode: int}>} A promise that resolves to an object confirming the ledger definition was archived.
23642364
*/
2365-
archiveLedgerDefinition({ auth, org, ledgerName, headers, context }) {
2365+
archiveLedger({ auth, org, ledgerName, headers, context }) {
23662366
return this.delete({
23672367
uri: `/v1/orgs/${org}/ledgers/${ledgerName}`,
23682368
auth,
@@ -2380,9 +2380,9 @@ class Particle {
23802380
* @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
23812381
* @param {Object} [options.context] Request context.
23822382
*
2383-
* @returns {Promise<{body: {definition: ResponseLedgerDefinition[]}, statusCode: int}>} A promise that resolves to an array of ledger definition data.
2383+
* @returns {Promise<{body: {ledgers: ResponseLedger[]}, statusCode: int}>} A promise that resolves to an array of ledger definition data.
23842384
*/
2385-
listLedgerDefinitions({ auth, org, headers, context }) {
2385+
listLedgers({ auth, org, headers, context }) {
23862386
return this.get({
23872387
uri: `/v1/orgs/${org}/ledgers`,
23882388
auth,
@@ -2448,7 +2448,7 @@ class Particle {
24482448
* @param {Object} [options.headers] Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
24492449
* @param {Object} [options.context] Request context.
24502450
*
2451-
* @returns {Promise<{body: {archived: Boolean}, statusCode: int}>} A promise that resolves to an object confirming the ledger instance was deleted.
2451+
* @returns {Promise<{body: undefined, statusCode: int}>} A promise that resolves to an object confirming the ledger instance was deleted.
24522452
*/
24532453
deleteLedgerInstance({ auth, org, ledgerName, scopeValue, headers, context }) {
24542454
return this.delete({

‎test/Particle.spec.js

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ const props = {
123123
]
124124
},
125125
ledgerName: 'myledger',
126-
definition: {
126+
ledger: {
127127
scope: 'Owner',
128128
name: 'myledger',
129129
description: 'my ledger',
@@ -2736,15 +2736,15 @@ describe('ParticleAPI', () => {
27362736
});
27372737
});
27382738

2739-
describe('.createLedgerDefinition', () => {
2739+
describe('.createLedger', () => {
27402740
it('generates request', () => {
2741-
return api.createLedgerDefinition(propsWithOrg).then((results) => {
2741+
return api.createLedger(propsWithOrg).then((results) => {
27422742
results.should.match({
27432743
method: 'post',
27442744
uri: `/v1/orgs/${org}/ledgers`,
27452745
auth: props.auth,
27462746
data: {
2747-
definition: {
2747+
ledger: {
27482748
scope: 'Owner',
27492749
name: 'myledger',
27502750
description: 'my ledger',
@@ -2756,9 +2756,9 @@ describe('ParticleAPI', () => {
27562756
});
27572757
});
27582758

2759-
describe('.getLedgerDefinition', () => {
2759+
describe('.getLedger', () => {
27602760
it('generates request', () => {
2761-
return api.getLedgerDefinition(propsWithOrg).then((results) => {
2761+
return api.getLedger(propsWithOrg).then((results) => {
27622762
results.should.match({
27632763
method: 'get',
27642764
uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}`,
@@ -2768,15 +2768,15 @@ describe('ParticleAPI', () => {
27682768
});
27692769
});
27702770

2771-
describe('.updateLedgerDefinition', () => {
2771+
describe('.updateLedger', () => {
27722772
it('generates request', () => {
2773-
return api.updateLedgerDefinition(propsWithOrg).then((results) => {
2773+
return api.updateLedger(propsWithOrg).then((results) => {
27742774
results.should.match({
27752775
method: 'put',
27762776
uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}`,
27772777
auth: props.auth,
27782778
data: {
2779-
definition: {
2779+
ledger: {
27802780
scope: 'Owner',
27812781
name: 'myledger',
27822782
description: 'my ledger',
@@ -2788,9 +2788,9 @@ describe('ParticleAPI', () => {
27882788
});
27892789
});
27902790

2791-
describe('.archiveLedgerDefinition', () => {
2791+
describe('.archiveLedger', () => {
27922792
it('generates request', () => {
2793-
return api.archiveLedgerDefinition(propsWithOrg).then((results) => {
2793+
return api.archiveLedger(propsWithOrg).then((results) => {
27942794
results.should.match({
27952795
method: 'delete',
27962796
uri: `/v1/orgs/${org}/ledgers/${props.ledgerName}`,
@@ -2800,9 +2800,9 @@ describe('ParticleAPI', () => {
28002800
});
28012801
});
28022802

2803-
describe('.listLedgerDefinitions', () => {
2803+
describe('.listLedgers', () => {
28042804
it('generates request', () => {
2805-
return api.listLedgerDefinitions(propsWithOrg).then((results) => {
2805+
return api.listLedgers(propsWithOrg).then((results) => {
28062806
results.should.match({
28072807
method: 'get',
28082808
uri: `/v1/orgs/${org}/ledgers`,

0 commit comments

Comments
 (0)