This repository was archived by the owner on Apr 28, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Documented some API Response objects
- Loading branch information
Showing
5 changed files
with
110 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Class: `ApiResponseBase` | ||
|
||
#### Short summary of the class object and what it does. | ||
|
||
## Class Properties | ||
|
||
- #### Private Properties | ||
- `attribute_one`: **_string_** | ||
|
||
# Public Methods | ||
|
||
## constructor() | ||
|
||
- #### constructor(args: { foo?: _[string]()_, bar?: _[string]()_, opt?: _[boolean]()_ }) | ||
|
||
- CShort description of the class method and what it does. | ||
|
||
## set_attributes() | ||
|
||
- #### set_attributes(args: { option?: _[boolean]()_ }): [return type]() | ||
|
||
- Short description of the class method and what it does. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Class: `Config` extends `ApiResponseBase` | ||
|
||
#### Represents the response given from the Configs API endpoint. | ||
|
||
## Class Properties | ||
|
||
- #### Public Properties | ||
- `attributes`: _[object]()_ | ||
- `is_app_update_required`: _[boolean]()_ | _null_ | ||
- `is_live`: _[boolean]()_ | _null_ | ||
- `is_uploads_enabled`: _[boolean]()_ | _null_ | ||
- `app_share_url`: _[string]()_ | _null_ | ||
- `multi_invite_text`: _[string]()_ | _null_ | ||
- `invite_text_body`: _[string]()_ | _null_ | ||
- `invite_share_view_description`: _[string]()_ | _null_ | ||
- `minimum_posts_hide_invite_share`: _[number]()_ | _null_ | ||
- `minimum_posted_hide_invite_share`: _[number]()_ | _null_ | ||
- `minimum_feed_hide_invite_share`: _[number]()_ | _null_ | ||
- `snap_username`: _[string]()_ | _null_ | ||
- `ig_username`: _[string]()_ | _null_ | ||
- `twitter_username`: _[string]()_ | _null_ | ||
- `default_reaction_emojis`: [Array]()<_[string]()_> | _null_ | ||
- `delete_account_available`: _[boolean]()_ | _null_ | ||
- `in_app_post_message`: _[string]()_ | _null_ | ||
- `onboarding_invite_user_filter`: _[boolean]()_ | _null_ | ||
- `is_auto_follow_on`: _[boolean]()_ | _null_ | ||
- `max_name_length`: _[number]()_ | _null_ | ||
|
||
# Public Methods | ||
|
||
## constructor() | ||
|
||
- #### constructor(bundle_version: _[string]()_, args: {}) | ||
|
||
- Sets the bundle version on a new Config object. Still a WIP. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Class: `Session` extends `ApiResponseBase` | ||
|
||
#### Short summary of the class object and what it does. | ||
|
||
## Class Properties | ||
|
||
- #### Private Properties | ||
- `attribute_one`: **_string_** | ||
|
||
# Public Methods | ||
|
||
## constructor() | ||
|
||
- #### constructor(args: { foo?: _[string]()_, bar?: _[string]()_, opt?: _[boolean]()_ }) | ||
|
||
- CShort description of the class method and what it does. | ||
|
||
## set_phone_number() | ||
|
||
- #### set_attributes(args: { option?: _[boolean]()_ }): [return type]() | ||
|
||
- Short description of the class method and what it does. | ||
|
||
## set_verify_code() | ||
|
||
- #### set_attributes(args: { option?: _[boolean]()_ }): [return type]() | ||
|
||
- Short description of the class method and what it does. |