Skip to content

Commit 893cf91

Browse files
cargix1cargix1
authored
Merge pull request #66 from kristofers91/master
Removing unnecessary methods, Added new methods, updated descriptions and fixed some typos.
2 parents 842b1d3 + 8a74912 commit 893cf91

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+548
-504
lines changed

‎src/resources/application-charge.php

Lines changed: 8 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/**
1818
* getApplicationCharges() method
1919
*
20-
* reference: http://docs.shopify.com/api/applicationcharge
20+
* reference: https://help.shopify.com/api/reference/applicationcharge
2121
*/
2222
"getApplicationCharges" => array(
2323
"httpMethod" => "GET",
@@ -42,12 +42,12 @@
4242
/**
4343
* getApplicationCharge() method
4444
*
45-
* reference: http://docs.shopify.com/api/applicationcharge
45+
* reference: https://help.shopify.com/api/reference/applicationcharge
4646
*/
4747
"getApplicationCharge" => array(
4848
"httpMethod" => "GET",
4949
"uri" => "/admin/application_charges/{id}.json",
50-
"summary" => "Retrive a single application charge.",
50+
"summary" => "Retrieve a single application charge.",
5151
"responseModel" => "defaultJsonResponse",
5252
"parameters" => array(
5353
"id" => array(
@@ -68,7 +68,7 @@
6868
/**
6969
* createApplicationCharge() method
7070
*
71-
* reference: http://docs.shopify.com/api/applicationcharge
71+
* reference: https://help.shopify.com/api/reference/applicationcharge
7272
*/
7373
"createApplicationCharge" => array(
7474
"httpMethod" => "POST",
@@ -106,11 +106,11 @@
106106

107107

108108
/**
109-
* activeApplicationCharge() method
109+
* activateApplicationCharge() method
110110
*
111-
* reference: http://docs.shopify.com/api/applicationcharge
111+
* reference: https://help.shopify.com/api/reference/applicationcharge
112112
*/
113-
"activeApplicationCharge" => array(
113+
"activateApplicationCharge" => array(
114114
"httpMethod" => "POST",
115115
"uri" => "/admin/application_charges/{id}/activate.json",
116116
"summary" => "Activate a previously accepted one-time application charge.",
@@ -169,113 +169,7 @@
169169
)
170170
)
171171
),
172-
173-
/**
174-
* getArticle() method
175-
*
176-
* reference: http://docs.shopify.com/api/article
177-
*/
178-
"getArticle" => array(
179-
"httpMethod" => "GET",
180-
"uri" => "/admin/blogs/{blog_id}/articles/{article_id}.json",
181-
"summary" => "Get a single article by its ID and the ID of the parent blog.",
182-
"responseModel" => "defaultJsonResponse",
183-
"parameters" => array(
184-
"blog_id" => array(
185-
"type" => "number",
186-
"location" => "uri",
187-
"description" => "The ID of the Blog.",
188-
"required" => true
189-
),
190-
"article_id" => array(
191-
"type" => "number",
192-
"location" => "uri",
193-
"description" => "The ID of the Article.",
194-
"required" => true
195-
),
196-
"fields" => array(
197-
"type" => "string",
198-
"location" => "query",
199-
"description" => "comma-separated list of fields to include in the response."
200-
)
201-
)
202-
),
203-
204-
/**
205-
* createArticle() method
206-
*
207-
* reference: http://docs.shopify.com/api/article
208-
*/
209-
"createArticle" => array(
210-
"httpMethod" => "POST",
211-
"uri" => "/admin/blogs/{blog_id}/articles.json",
212-
"summary" => "Create a new article for a blog",
213-
"responseModel" => "defaultJsonResponse",
214-
"parameters" => array(
215-
"blog_id" => array(
216-
"type" => "number",
217-
"location" => "uri",
218-
"description" => "A unique numeric identifier for the blog containing the article.",
219-
"required" => true
220-
),
221-
"article" => array(
222-
"location" => "json",
223-
"parameters" => array(
224-
"author" => array(
225-
"type" => "string",
226-
"location" => "json",
227-
"description" => "The name of the author of this article."
228-
),
229-
"title" => array(
230-
"type" => "string",
231-
"location" => "json",
232-
"description" => "The title of the article."
233-
),
234-
"author" => array(
235-
"type" => "string",
236-
"location" => "json",
237-
"description" => "The name of the author of this article."
238-
),
239-
"tags" => array(
240-
"type" => "string",
241-
"location" => "json",
242-
"description" => "Tags are additional short descriptors formatted as a string of comma-separated values. For example, if an article has three tags: tag1, tag2, tag3."
243-
),
244-
"summary_html" => array(
245-
"type" => "string",
246-
"location" => "json",
247-
"description" => "The text of the summary of the article, complete with HTML markup."
248-
),
249-
"body_html" => array(
250-
"type" => "string",
251-
"location" => "json",
252-
"description" => "The text of the body of the article, complete with HTML markup."
253-
),
254-
"template_suffix" => array(
255-
"type" => "string",
256-
"location" => "json",
257-
"description" => "States the name of the template an article is using if it is using an alternate template. If an article is using the default article.liquid template, the value returned is \"null\"."
258-
),
259-
"published" => array(
260-
"type" => "boolean",
261-
"location" => "json",
262-
"description" => "States whether or not the article is visible. Valid values are \"true\" for published or \"false\" for hidden."
263-
),
264-
"published_at" => array(
265-
"type" => "string",
266-
"location" => "json",
267-
"description" => "The date and time when the article was published. The API returns this value in ISO 8601 format."
268-
),
269-
"user_id" => array(
270-
"type" => "number",
271-
"location" => "json",
272-
"description" => "A unique numeric identifier for the author of the article."
273-
)
274-
)
275-
)
276-
)
277-
),
278-
172+
279173
),
280174

281175

‎src/resources/application-credit.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"getApplicationCredit" => array(
4343
"httpMethod" => "GET",
4444
"uri" => "/admin/application_credits/{id}.json",
45-
"summary" => "Retrive a single application credit.",
45+
"summary" => "Retrieve a single application credit.",
4646
"responseModel" => "defaultJsonResponse",
4747
"parameters" => array(
4848
"id" => array(

‎src/resources/article.php

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@
1717
/**
1818
* getArticles() method
1919
*
20-
* reference: http://docs.shopify.com/api/article
20+
* reference: https://help.shopify.com/api/reference/article
2121
*/
2222
"getArticles" => array(
2323
"httpMethod" => "GET",
2424
"uri" => "/admin/blogs/{blog_id}/articles.json",
25-
"summary" => "Get a list of all articles from a certain blog.",
25+
"summary" => "Get a list of all articles from a specific blog.",
2626
"responseModel" => "defaultJsonResponse",
2727
"parameters" => array(
2828
"blog_id" => array(
@@ -81,6 +81,21 @@
8181
"location" => "query",
8282
"description" => "published - Show only published articles. unpublished - Show only unpublished articles. any - Show all articles (default)."
8383
),
84+
"handle" => array(
85+
"type" => "string",
86+
"location" => "query",
87+
"description" => "Filter by article handle"
88+
),
89+
"tag" => array(
90+
"type" => "string",
91+
"location" => "query",
92+
"description" => "Filter by article tag"
93+
),
94+
"author" => array(
95+
"type" => "string",
96+
"location" => "query",
97+
"description" => "Filter by article author"
98+
),
8499
"fields" => array(
85100
"type" => "string",
86101
"location" => "query",
@@ -93,12 +108,12 @@
93108
/**
94109
* getArticlesCount() method
95110
*
96-
* reference: http://docs.shopify.com/api/article
111+
* reference: https://help.shopify.com/api/reference/article
97112
*/
98113
"getArticlesCount" => array(
99114
"httpMethod" => "GET",
100115
"uri" => "/admin/blogs/{blog_id}/articles/count.json",
101-
"summary" => "Get a count of all articles from a certain blog.",
116+
"summary" => "Get a count of all articles from a specific blog.",
102117
"responseModel" => "defaultJsonResponse",
103118
"parameters" => array(
104119
"blog_id" => array(
@@ -149,12 +164,12 @@
149164
/**
150165
* getArticle() method
151166
*
152-
* reference: http://docs.shopify.com/api/article
167+
* reference: https://help.shopify.com/api/reference/article
153168
*/
154169
"getArticle" => array(
155170
"httpMethod" => "GET",
156171
"uri" => "/admin/blogs/{blog_id}/articles/{article_id}.json",
157-
"summary" => "Get a single article by its ID and the ID of the parent blog.",
172+
"summary" => "Get a single article by its ID from a specific blog.",
158173
"responseModel" => "defaultJsonResponse",
159174
"parameters" => array(
160175
"blog_id" => array(
@@ -181,12 +196,12 @@
181196
/**
182197
* createArticle() method
183198
*
184-
* reference: http://docs.shopify.com/api/article
199+
* reference: https://help.shopify.com/api/reference/article
185200
*/
186201
"createArticle" => array(
187202
"httpMethod" => "POST",
188203
"uri" => "/admin/blogs/{blog_id}/articles.json",
189-
"summary" => "Create a new article for a blog",
204+
"summary" => "Create a new article for a specific blog",
190205
"responseModel" => "defaultJsonResponse",
191206
"parameters" => array(
192207
"blog_id" => array(
@@ -257,12 +272,12 @@
257272
/**
258273
* updateArticle() method
259274
*
260-
* reference: http://docs.shopify.com/api/article
275+
* reference: https://help.shopify.com/api/reference/article
261276
*/
262277
"updateArticle" => array(
263278
"httpMethod" => "PUT",
264279
"uri" => "/admin/blogs/{blog_id}/articles/{article_id}.json",
265-
"summary" => "Create a new article for a blog.",
280+
"summary" => "Update an article from a specific blog.",
266281
"responseModel" => "defaultJsonResponse",
267282
"parameters" => array(
268283
"blog_id" => array(
@@ -343,7 +358,7 @@
343358
/**
344359
* getAuthors() method
345360
*
346-
* reference: http://docs.shopify.com/api/article
361+
* reference: https://help.shopify.com/api/reference/article
347362
*/
348363
"getAuthors" => array(
349364
"httpMethod" => "GET",
@@ -356,7 +371,7 @@
356371
/**
357372
* getTags() method
358373
*
359-
* reference: http://docs.shopify.com/api/article
374+
* reference: https://help.shopify.com/api/reference/article
360375
*/
361376
"getTags" => array(
362377
"httpMethod" => "GET",
@@ -381,7 +396,7 @@
381396
/**
382397
* getBlogTags() method
383398
*
384-
* reference: http://docs.shopify.com/api/article
399+
* reference: https://help.shopify.com/api/reference/article
385400
*/
386401
"getBlogTags" => array(
387402
"httpMethod" => "GET",
@@ -412,12 +427,12 @@
412427
/**
413428
* deleteArticle() method
414429
*
415-
* reference: http://docs.shopify.com/api/article
430+
* reference: https://help.shopify.com/api/reference/article
416431
*/
417432
"deleteArticle" => array(
418433
"httpMethod" => "DELETE",
419434
"uri" => "/admin/blogs/{blog_id}/articles/{article_id}.json",
420-
"summary" => "Delete an article of a blog.",
435+
"summary" => "Delete an article from a specific blog.",
421436
"responseModel" => "defaultJsonResponse",
422437
"parameters" => array(
423438
"blog_id" => array(

‎src/resources/asset.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/**
1818
* getAssets() method
1919
*
20-
* reference: http://docs.shopify.com/api/asset
20+
* reference: https://help.shopify.com/api/reference/asset
2121
*/
2222
"getAssets" => array(
2323
"httpMethod" => "GET",
@@ -42,7 +42,7 @@
4242
/**
4343
* getAsset() method
4444
*
45-
* reference: http://docs.shopify.com/api/asset
45+
* reference: https://help.shopify.com/api/reference/asset
4646
*/
4747
"getAsset" => array(
4848
"httpMethod" => "GET",
@@ -68,7 +68,7 @@
6868
/**
6969
* updateAsset() method
7070
*
71-
* reference: http://docs.shopify.com/api/asset
71+
* reference: https://help.shopify.com/api/reference/asset
7272
*/
7373
"updateAsset" => array(
7474
"httpMethod" => "PUT",
@@ -119,7 +119,7 @@
119119
/**
120120
* deleteAsset() method
121121
*
122-
* reference: http://docs.shopify.com/api/asset
122+
* reference: https://help.shopify.com/api/reference/asset
123123
*/
124124
"deleteAsset" => array(
125125
"httpMethod" => "DELETE",

0 commit comments

Comments
 (0)